@purr-core/utils.definitions 0.0.11 → 0.0.12

package/dist/index.cjs

@@ -0,0 +1 @@
+'use strict';

package/dist/index.d.cts

@@ -0,0 +1,40 @@
+/**
+ * A type alias for `any`. This type can represent any value.
+ *
+ * @remarks
+ * Use this type with caution as it disables type checking for the value it is assigned to.
+ */
+type TAny = any;
+/**
+ * A type representing a function that iterates over an array.
+ *
+ * @template T - The type of elements in the array.
+ * @param value - The current element being processed in the array.
+ * @param index - The index of the current element being processed in the array.
+ * @param array - The array that `TIterator` is iterating over.
+ * @returns An unknown value.
+ */
+type TIterator = <T>(value: T, index?: number, array?: T[]) => unknown;
+/**
+ * Represents the boundary of an asynchronous operation, encapsulating both the result and any potential error.
+ *
+ * @template T - The type of the result.
+ * @property {unknown | null} error - The error encountered during the asynchronous operation, if any.
+ * @property {T | null} result - The result of the asynchronous operation, if successful.
+ */
+type TAsyncBoundary<T> = {
+    error: unknown | null;
+    result: Awaited<T> | null;
+};
+
+/**
+ * Represents an extendable object where keys are strings and values can be of any type.
+ *
+ * @interface IExtendable
+ * @template TAny - The type of the values in the extendable object.
+ */
+interface IExtendable {
+    [key: string]: TAny;
+}
+
+export type { IExtendable, TAny, TAsyncBoundary, TIterator };

package/dist/index.d.ts

@@ -0,0 +1,40 @@
+/**
+ * A type alias for `any`. This type can represent any value.
+ *
+ * @remarks
+ * Use this type with caution as it disables type checking for the value it is assigned to.
+ */
+type TAny = any;
+/**
+ * A type representing a function that iterates over an array.
+ *
+ * @template T - The type of elements in the array.
+ * @param value - The current element being processed in the array.
+ * @param index - The index of the current element being processed in the array.
+ * @param array - The array that `TIterator` is iterating over.
+ * @returns An unknown value.
+ */
+type TIterator = <T>(value: T, index?: number, array?: T[]) => unknown;
+/**
+ * Represents the boundary of an asynchronous operation, encapsulating both the result and any potential error.
+ *
+ * @template T - The type of the result.
+ * @property {unknown | null} error - The error encountered during the asynchronous operation, if any.
+ * @property {T | null} result - The result of the asynchronous operation, if successful.
+ */
+type TAsyncBoundary<T> = {
+    error: unknown | null;
+    result: Awaited<T> | null;
+};
+
+/**
+ * Represents an extendable object where keys are strings and values can be of any type.
+ *
+ * @interface IExtendable
+ * @template TAny - The type of the values in the extendable object.
+ */
+interface IExtendable {
+    [key: string]: TAny;
+}
+
+export type { IExtendable, TAny, TAsyncBoundary, TIterator };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@purr-core/utils.definitions",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.js",