@typedly/data-traits 1.0.0 → 1.1.0

package/README.md

@@ -51,6 +51,7 @@ A **TypeScript** type definitions package for configurable data traits, providin
 - **Serializable**: Serialize and deserialize data values with async support
 - **Timestamped**: Automatic tracking of creation, modification, and access times
 - **Transformable**: Transform values with `map` and `flatMap` operations
+- **Traversable**: Adds required iterable iterator, and optional async iterable iterator
 - **Validatable**: Comprehensive validation system with custom validators and error reporting
 - **Versionable**: Version control with history tracking, snapshots, and rollback support
 
@@ -85,6 +86,7 @@ A **TypeScript** type definitions package for configurable data traits, providin
     - [`Serializable`](#serializable)
     - [`Timestamped`](#timestamped)
     - [`Transformable`](#transformable)
+    - [`Traversable`](#traversable)
     - [`Validatable`](#validatable)
     - [`Versionable`](#versionable)
 - [Contributing](#contributing)
@@ -140,6 +142,7 @@ import {
   Serializable,
   Timestamped,
   Transformable,
+  Traversable,
   Validatable,
   Versionable,
 } from '@typedly/data-traits';
@@ -397,6 +400,16 @@ import { Transformable } from '@typedly/data-traits';
 
 [Source](https://github.com/typedly/data-traits/blob/main/src/lib/transformable.trait.ts)
 
+### `Traversable`
+
+Capability for objects that can be traversed/iterated.
+
+```typescript
+import { Traversable } from '@typedly/data-traits';
+```
+
+[Source](https://github.com/typedly/data-traits/blob/main/src/lib/traversable.trait.ts)
+
 ### `Validatable`
 
 Interface for data types that can be validated with custom rules and track validation errors.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typedly/data-traits",
-  "version": "1.0.0",
+  "version": "1.1.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

@@ -689,6 +689,25 @@ 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
@@ -757,4 +776,4 @@ interface Versionable<T, V = unknown, R extends boolean = false> extends Reverti
     snapshot(): AsyncReturn<R, T>;
 }
 
-export type { Adaptable, Cacheable, Cleanable, Cloneable, Collection, Comparable, Compressible, Configurable, Encryptable, Exportable, Freezable, Identifiable, Indexable, Measurable, Mergeable, Observable, Paginated, Persistable, Printable, Queryable, Resettable, Revertible, Serializable, Timestamped, Transformable, Validatable, Versionable };
+export type { Adaptable, Cacheable, Cleanable, Cloneable, Collection, Comparable, Compressible, Configurable, Encryptable, Exportable, Freezable, Identifiable, Indexable, Measurable, Mergeable, Observable, Paginated, Persistable, Printable, Queryable, Resettable, Revertible, Serializable, Timestamped, Transformable, Traversable, Validatable, Versionable };