@purr-react-core/utils.definitions 0.0.14

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Dinh Thien Phuc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

@@ -0,0 +1,37 @@
+{
+  "name": "@purr-react-core/utils.definitions",
+  "version": "0.0.14",
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0"
+  },
+  "author": "@DinhThienPhuc",
+  "license": "ISC",
+  "description": "",
+  "sideEffects": false,
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "tsc && vite build",
+    "build:vite": "tsc && vite build",
+    "build:tsup": "tsup",
+    "lint": "eslint . --ext ts,tsx --max-warnings 0"
+  }
+}