@typedly/data-traits 1.1.0 → 2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typedly/data-traits",
-  "version": "1.1.0",
+  "version": "2.0.0",
   "author": "wwwdev.io <dev@wwwdev.io>",
   "description": "A TypeScript type definitions package for configurable data traits, providing various kinds of configurable data interfaces.",
   "license": "MIT",

package/types/typedly-data-traits.d.ts

@@ -100,6 +100,25 @@ interface Cloneable<O, R extends boolean = false> {
     cloneWith?(options: O): AsyncReturn<R, this>;
 }
 
+/**
+ * @description Capability for objects that can be traversed/iterated.
+ * @export
+ * @interface Traversable
+ * @template E The element type
+ */
+interface Traversable<E> {
+    /**
+     * @description Synchronous iterator
+     * @returns {IterableIterator<E>}
+     */
+    [Symbol.iterator](): IterableIterator<E>;
+    /**
+     * @description Asynchronous iterator
+     * @returns {AsyncIterableIterator<E>}
+     */
+    [Symbol.asyncIterator]?(): AsyncIterableIterator<E>;
+}
+
 /**
  * @description Trait for collection-like data types that can hold multiple items and provide methods for adding, deleting, and iterating over those items.
  * @export
@@ -107,7 +126,7 @@ interface Cloneable<O, R extends boolean = false> {
  * @template E Element type contained in the collection.
  * @template {boolean} [R=false] whether the methods return a `Promise` or not.
  */
-interface Collection<E, R extends boolean = false> extends Iterable<E>, AsyncIterable<E> {
+interface Collection<E, R extends boolean = false> extends Traversable<E> {
     /**
      * @description The number of items in the collection.
      * @returns {number}
@@ -129,7 +148,7 @@ interface Collection<E, R extends boolean = false> extends Iterable<E>, AsyncIte
      * @description Executes a provided function once for each collection element.
      * @param {(element: E, collection: Collection<E, R>) => void} callbackfn Function to execute for each element.
      * @param {?*} [thisArg] Value to use as `this` when executing `callbackfn`.
-     * @returns {AsyncReturn<R, this>}
+     * @returns {AsyncReturn<R, this>} The collection instance `this`, or in `Promise`.
      */
     forEach(callbackfn: (element: E, collection: Collection<E, R>) => void, thisArg?: any): AsyncReturn<R, this>;
     /**
@@ -689,25 +708,6 @@ interface Transformable<T, R extends boolean = false> {
     map<U>(fn: (value: T) => U): AsyncReturn<R, U>;
 }
 
-/**
- * @description Capability for objects that can be traversed/iterated.
- * @export
- * @interface Traversable
- * @template E The element type
- */
-interface Traversable<E> {
-    /**
-     * @description Synchronous iterator
-     * @returns {IterableIterator<E>}
-     */
-    [Symbol.iterator](): IterableIterator<E>;
-    /**
-     * @description Asynchronous iterator
-     * @returns {AsyncIterableIterator<E>}
-     */
-    [Symbol.asyncIterator]?(): AsyncIterableIterator<E>;
-}
-
 /**
  * @description Interface for data types that can be validated with custom rules and track validation errors.
  * @export