@purr-core/utils.definitions 0.0.1

package/dist/_interfaces.d.ts

@@ -0,0 +1,11 @@
+import { TAny } from './_types';
+
+/**
+ * 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.
+ */
+export interface IExtendable {
+    [key: string]: TAny;
+}

package/dist/_types.d.ts

@@ -0,0 +1,58 @@
+import { ReactElement, ReactNode } from 'react';
+
+/**
+ * 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.
+ */
+export type TAny = any;
+/**
+ * Type definition for a React component function.
+ *
+ * @typedef {TComponent}
+ *
+ * @param {...TAny} args - The arguments passed to the component.
+ *
+ * @returns {ReactNode} - The rendered React node.
+ */
+export type TComponent = (...args: TAny) => ReactNode;
+/**
+ * A type representing a higher-order component (HOC) function.
+ *
+ * This function takes a React element or node as an argument and returns a React node.
+ *
+ * @param component - The React element or node to be wrapped by the HOC.
+ * @returns A new React node after applying the HOC.
+ */
+export type THighOrderComponent = (component: ReactElement | ReactNode) => ReactNode;
+/**
+ * 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.
+ */
+export type TIterator = <T>(value: T, index?: number, array?: T[]) => unknown;
+/**
+ * A generic function type that takes an optional parameter of type `T` and returns a value of type `RT`.
+ *
+ * @template RT - The return type of the function.
+ * @template T - The type of the optional parameter.
+ * @param item - An optional parameter of type `T`.
+ * @returns A value of type `RT`.
+ */
+export type TFunction<RT> = <T>(item?: T) => RT;
+/**
+ * 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.
+ */
+export type TAsyncBoundary<T> = {
+    error: unknown | null;
+    result: T | null;
+};

package/dist/index.cjs

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

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './_interfaces';
+export * from './_types';

package/dist/index.js

@@ -0,0 +1 @@
+

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@purr-core/utils.definitions",
+  "version": "0.0.1",
+  "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": {
+    "typescript": "*",
+    "react": "*"
+  },
+  "author": "@DinhThienPhuc",
+  "license": "ISC",
+  "description": "",
+  "sideEffects": false,
+  "scripts": {
+    "dev": "vite build --watch",
+    "build": "tsc && vite build",
+    "lint": "eslint . --ext ts,tsx --max-warnings 0"
+  }
+}