@typedly/collection 1.0.0 → 1.1.0

package/README.md

@@ -16,6 +16,7 @@ A **TypeScript** type definitions package for data collections with customizable
 
 ## Features
 
+- **Adapter**: The default interface for adapters in collections.
 - **Constructor**: The constructor type for initialization with custom storage (e.g. `Set`, `Array`).
 - **Shape**: The shape of element-based collection built on @typedly/data.
 - **Customizable Storage**: Support for various storage types (`Set<T>`, `T[]`, etc.) via generics with add/remove/iterate.
@@ -27,6 +28,7 @@ A **TypeScript** type definitions package for data collections with customizable
 - [Installation](#installation)
 - [Api](#api)
   - Interface
+    - [`CollectionAdapter`](#collectionadapter)
     - [`CollectionShape`](#collectionshape)
   - Type
     - [`CollectionConstructor`](#collectionconstructor)
@@ -49,6 +51,7 @@ npm install @typedly/collection --save-peer
 ```typescript
 import {
   // Interface.
+  CollectionAdapter,
   CollectionShape,
   // Type.
   CollectionConstructor
@@ -57,6 +60,14 @@ import {
 
 ### Interface
 
+### `CollectionAdapter`
+
+The adapter interface for collections.
+
+```typescript
+import { CollectionAdapter } from '@typedly/collection';
+```
+
 ### `CollectionShape`
 
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typedly/collection",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "author": "wwwdev.io <dev@wwwdev.io>",
   "description": "A TypeScript type definitions package for data collections with customizable storage.",
   "license": "MIT",

package/types/typedly-collection.d.ts

@@ -1,2 +1,75 @@
+import { DataShape } from '@typedly/data';
+import { ConstrainedConstructor } from '@typedly/constructor';
 
-export { };
+/**
+ * @description Represents a collection of elements.
+ * @export
+ * @interface Collection
+ * @template T The type of elements in the collection.
+ * @template V The type of the value in the collection, data of elements.
+ * @extends {DataShape<V>}
+ */
+interface CollectionShape<T, V = any> extends DataShape<V> {
+    /**
+     * @description Adds an item to the collection.
+     * @param {T} element Element of type `T` to add.
+     * @returns {this} The collection instance.
+     */
+    add(element: T): this;
+    /**
+     * @description Deletes an item from the collection.
+     * @param {T} element Element of type `T` to delete.
+     * @returns {boolean} `true` if the element was successfully deleted, otherwise `false`.
+     */
+    delete(element: T): boolean;
+    /**
+     * @description Executes a provided function once for each collection element.
+     * @param {(value: T, value2: T, collection: CollectionShape<T, V>) => void} callbackfn Function to execute for each element.
+     * @param {any} [thisArg] Value to use as `this` when executing `callbackfn`.
+     */
+    forEach(callbackfn: (element: T, element2: T, collection: CollectionShape<T, V>) => void, thisArg?: any): void;
+    /**
+     * @description Checks if an item exists in the collection.
+     * @param {T} element Element of type `T` to check for existence.
+     * @returns {boolean} `true` if the element exists, otherwise `false`.
+     */
+    has(element: T): boolean;
+    /**
+     * @description The number of items in the collection.
+     * @returns {number}
+     */
+    readonly size: number;
+    /**
+     * @description Returns a tag name for collection.
+     * @returns {string}
+     */
+    get [Symbol.toStringTag](): string;
+    /**
+     * @description Returns an iterator for the collection.
+     * @returns {Iterator<T>}
+     */
+    get [Symbol.iterator](): Iterator<T>;
+}
+
+/**
+ * @description The adapter interface for collections.
+ * @export
+ * @interface CollectionAdapter
+ * @template Element  The type of elements in the collection.
+ * @template Type The type of the value in the collection, data of elements.
+ * @extends {CollectionShape<Element, Type>}
+ */
+interface CollectionAdapter<Element, Type> extends CollectionShape<Element, Type> {
+    version: string;
+}
+
+/**
+ * @description The constructor type for CollectionShape.
+ * @export
+ * @template T The type of the elements in the collection.
+ * @template V The type of the value in the collection, data of elements.
+ * @template {CollectionShape<T, V>} C
+ */
+type CollectionConstructor<T, V, C extends CollectionShape<T, V>> = ConstrainedConstructor<CollectionShape<T, V>, C, T[]>;
+
+export type { CollectionAdapter, CollectionConstructor, CollectionShape };