@fluixi/core 1.0.0-alpha.53

package/dist/src/lib/utils/index.d.ts

@@ -0,0 +1,379 @@
+/**
+ * @fileoverview General utilities for Fluixi
+ * @module @fluixi/core/utils
+ *
+ * This module provides general utility functions for common operations.
+ */
+/**
+ * Debounces a function call
+ *
+ * @template T - Function type
+ * @param {T} fn - Function to debounce
+ * @param {number} delay - Delay in milliseconds
+ * @returns {(...args: Parameters<T>) => void} Debounced function
+ *
+ * @example
+ * ```typescript
+ * import { debounce } from '@fluixi/core/utils';
+ *
+ * const handleInput = debounce((value: string) => {
+ *   console.log('Input:', value);
+ * }, 300);
+ * ```
+ */
+export declare function debounce<T extends (...args: any[]) => any>(fn: T, delay: number): (...args: Parameters<T>) => void;
+/**
+ * Throttles a function call
+ *
+ * @template T - Function type
+ * @param {T} fn - Function to throttle
+ * @param {number} limit - Time limit in milliseconds
+ * @returns {(...args: Parameters<T>) => void} Throttled function
+ *
+ * @example
+ * ```typescript
+ * import { throttle } from '@fluixi/core/utils';
+ *
+ * const handleScroll = throttle(() => {
+ *   console.log('Scrolled');
+ * }, 100);
+ * ```
+ */
+export declare function throttle<T extends (...args: any[]) => any>(fn: T, limit: number): (...args: Parameters<T>) => void;
+/**
+ * Creates a memoized version of a function
+ *
+ * @template T - Function type
+ * @param {T} fn - Function to memoize
+ * @returns {T} Memoized function
+ *
+ * @example
+ * ```typescript
+ * import { memoize } from '@fluixi/core/utils';
+ *
+ * const expensiveCalc = memoize((n: number) => {
+ *   return n * n;
+ * });
+ * ```
+ */
+export declare function memoize<T extends (...args: any[]) => any>(fn: T): T;
+/**
+ * Deep clones an object
+ *
+ * @template T - Object type
+ * @param {T} obj - Object to clone
+ * @returns {T} Cloned object
+ *
+ * @example
+ * ```typescript
+ * import { deepClone } from '@fluixi/core/utils';
+ *
+ * const original = { a: 1, b: { c: 2 } };
+ * const copy = deepClone(original);
+ * ```
+ */
+export declare function deepClone<T>(obj: T): T;
+/**
+ * Deep merges multiple objects
+ *
+ * @template T - Object type
+ * @param {...Partial<T>[]} objects - Objects to merge
+ * @returns {T} Merged object
+ *
+ * @example
+ * ```typescript
+ * import { deepMerge } from '@fluixi/core/utils';
+ *
+ * const result = deepMerge(
+ *   { a: 1, b: { c: 2 } },
+ *   { b: { d: 3 } }
+ * );
+ * // { a: 1, b: { c: 2, d: 3 } }
+ * ```
+ */
+export declare function deepMerge<T extends Record<string, any>>(...objects: Partial<T>[]): T;
+/**
+ * Generates a unique ID
+ *
+ * @param {string} prefix - Optional prefix
+ * @returns {string} Unique ID
+ *
+ * @example
+ * ```typescript
+ * import { uniqueId } from '@fluixi/core/utils';
+ *
+ * const id = uniqueId('component-');
+ * // 'component-abc123def456'
+ * ```
+ */
+export declare function uniqueId(prefix?: string): string;
+/**
+ * Formats a number with commas
+ *
+ * @param {number} num - Number to format
+ * @returns {string} Formatted number
+ *
+ * @example
+ * ```typescript
+ * import { formatNumber } from '@fluixi/core/utils';
+ *
+ * formatNumber(1234567); // '1,234,567'
+ * ```
+ */
+export declare function formatNumber(num: number): string;
+/**
+ * Formats bytes to human readable string
+ *
+ * @param {number} bytes - Number of bytes
+ * @param {number} decimals - Decimal places (default: 2)
+ * @returns {string} Formatted string
+ *
+ * @example
+ * ```typescript
+ * import { formatBytes } from '@fluixi/core/utils';
+ *
+ * formatBytes(1024); // '1 KB'
+ * formatBytes(1048576); // '1 MB'
+ * ```
+ */
+export declare function formatBytes(bytes: number, decimals?: number): string;
+/**
+ * Capitalizes first letter of a string
+ *
+ * @param {string} str - String to capitalize
+ * @returns {string} Capitalized string
+ *
+ * @example
+ * ```typescript
+ * import { capitalize } from '@fluixi/core/utils';
+ *
+ * capitalize('hello'); // 'Hello'
+ * ```
+ */
+export declare function capitalize(str: string): string;
+/**
+ * Converts string to kebab-case
+ *
+ * @param {string} str - String to convert
+ * @returns {string} Kebab-case string
+ *
+ * @example
+ * ```typescript
+ * import { kebabCase } from '@fluixi/core/utils';
+ *
+ * kebabCase('HelloWorld'); // 'hello-world'
+ * ```
+ */
+export declare function kebabCase(str: string): string;
+/**
+ * Converts string to camelCase
+ *
+ * @param {string} str - String to convert
+ * @returns {string} CamelCase string
+ *
+ * @example
+ * ```typescript
+ * import { camelCase } from '@fluixi/core/utils';
+ *
+ * camelCase('hello-world'); // 'helloWorld'
+ * ```
+ */
+export declare function camelCase(str: string): string;
+/**
+ * Clamps a number between min and max
+ *
+ * @param {number} value - Value to clamp
+ * @param {number} min - Minimum value
+ * @param {number} max - Maximum value
+ * @returns {number} Clamped value
+ *
+ * @example
+ * ```typescript
+ * import { clamp } from '@fluixi/core/utils';
+ *
+ * clamp(5, 0, 10); // 5
+ * clamp(-5, 0, 10); // 0
+ * clamp(15, 0, 10); // 10
+ * ```
+ */
+export declare function clamp(value: number, min: number, max: number): number;
+/**
+ * Generates a random number between min and max
+ *
+ * @param {number} min - Minimum value
+ * @param {number} max - Maximum value
+ * @returns {number} Random number
+ *
+ * @example
+ * ```typescript
+ * import { random } from '@fluixi/core/utils';
+ *
+ * const num = random(1, 100);
+ * ```
+ */
+export declare function random(min: number, max: number): number;
+/**
+ * Checks if a value is empty
+ *
+ * @param {any} value - Value to check
+ * @returns {boolean} True if empty
+ *
+ * @example
+ * ```typescript
+ * import { isEmpty } from '@fluixi/core/utils';
+ *
+ * isEmpty(''); // true
+ * isEmpty([]); // true
+ * isEmpty({}); // true
+ * isEmpty(null); // true
+ * isEmpty('text'); // false
+ * ```
+ */
+export declare function isEmpty(value: any): boolean;
+/**
+ * Picks specific keys from an object
+ *
+ * @template T - Object type
+ * @template K - Keys to pick
+ * @param {T} obj - Source object
+ * @param {...K[]} keys - Keys to pick
+ * @returns {Pick<T, K>} Object with picked keys
+ *
+ * @example
+ * ```typescript
+ * import { pick } from '@fluixi/core/utils';
+ *
+ * const obj = { a: 1, b: 2, c: 3 };
+ * pick(obj, 'a', 'c'); // { a: 1, c: 3 }
+ * ```
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, ...keys: K[]): Pick<T, K>;
+/**
+ * Omits specific keys from an object
+ *
+ * @template T - Object type
+ * @template K - Keys to omit
+ * @param {T} obj - Source object
+ * @param {...K[]} keys - Keys to omit
+ * @returns {Omit<T, K>} Object without omitted keys
+ *
+ * @example
+ * ```typescript
+ * import { omit } from '@fluixi/core/utils';
+ *
+ * const obj = { a: 1, b: 2, c: 3 };
+ * omit(obj, 'b'); // { a: 1, c: 3 }
+ * ```
+ */
+export declare function omit<T extends object, K extends keyof T>(obj: T, ...keys: K[]): Omit<T, K>;
+/**
+ * Groups array items by a key
+ *
+ * @template T - Array item type
+ * @template K - Key type
+ * @param {T[]} array - Array to group
+ * @param {(item: T) => K} fn - Key extraction function
+ * @returns {Map<K, T[]>} Grouped items
+ *
+ * @example
+ * ```typescript
+ * import { groupBy } from '@fluixi/core/utils';
+ *
+ * const users = [
+ *   { name: 'Alice', role: 'admin' },
+ *   { name: 'Bob', role: 'user' },
+ *   { name: 'Charlie', role: 'admin' }
+ * ];
+ * const grouped = groupBy(users, u => u.role);
+ * // Map { 'admin' => [...], 'user' => [...] }
+ * ```
+ */
+export declare function groupBy<T, K>(array: T[], fn: (item: T) => K): Map<K, T[]>;
+/**
+ * Creates an array of numbers from start to end
+ *
+ * @param {number} start - Start number
+ * @param {number} end - End number
+ * @param {number} step - Step size (default: 1)
+ * @returns {number[]} Array of numbers
+ *
+ * @example
+ * ```typescript
+ * import { range } from '@fluixi/core/utils';
+ *
+ * range(0, 5); // [0, 1, 2, 3, 4, 5]
+ * range(0, 10, 2); // [0, 2, 4, 6, 8, 10]
+ * ```
+ */
+export declare function range(start: number, end: number, step?: number): number[];
+/**
+ * Retries an async function
+ *
+ * @template T - Return type
+ * @param {() => Promise<T>} fn - Async function to retry
+ * @param {number} retries - Number of retries (default: 3)
+ * @param {number} delay - Delay between retries in ms (default: 1000)
+ * @returns {Promise<T>} Promise that resolves with the result
+ *
+ * @example
+ * ```typescript
+ * import { retry } from '@fluixi/core/utils';
+ *
+ * const data = await retry(
+ *   () => fetch('/api/data').then(r => r.json()),
+ *   3,
+ *   1000
+ * );
+ * ```
+ */
+export declare function retry<T>(fn: () => Promise<T>, retries?: number, delay?: number): Promise<T>;
+/**
+ * Sleep for specified milliseconds
+ *
+ * @param {number} ms - Milliseconds to sleep
+ * @returns {Promise<void>} Promise that resolves after delay
+ *
+ * @example
+ * ```typescript
+ * import { sleep } from '@fluixi/core/utils';
+ *
+ * await sleep(1000); // Wait 1 second
+ * ```
+ */
+export declare function sleep(ms: number): Promise<void>;
+/**
+ * Type guard to check if value is defined
+ *
+ * @template T - Value type
+ * @param {T | null | undefined} value - Value to check
+ * @returns {value is T} True if value is defined
+ *
+ * @example
+ * ```typescript
+ * import { isDefined } from '@fluixi/core/utils';
+ *
+ * const values = [1, null, 2, undefined, 3];
+ * const defined = values.filter(isDefined); // [1, 2, 3]
+ * ```
+ */
+export declare function isDefined<T>(value: T | null | undefined): value is T;
+/**
+ * Creates a chainable pipe function
+ *
+ * @param {...Function[]} fns - Functions to chain
+ * @returns {Function} Piped function
+ *
+ * @example
+ * ```typescript
+ * import { pipe } from '@fluixi/core/utils';
+ *
+ * const transform = pipe(
+ *   (x: number) => x * 2,
+ *   (x: number) => x + 1,
+ *   (x: number) => x.toString()
+ * );
+ * transform(5); // '11'
+ * ```
+ */
+export declare function pipe<T>(...fns: Array<(arg: any) => any>): (arg: T) => any;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/lib/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/lib/utils/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EACxD,EAAE,EAAE,CAAC,EACL,KAAK,EAAE,MAAM,GACZ,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAOlC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EACxD,EAAE,EAAE,CAAC,EACL,KAAK,EAAE,MAAM,GACZ,CAAC,GAAG,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,KAAK,IAAI,CAUlC;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,GAAG,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,CAYnE;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,CAiCtC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACrD,GAAG,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GACvB,CAAC,CAwBH;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CAAC,MAAM,GAAE,MAAW,GAAG,MAAM,CAEpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAU,GAAG,MAAM,CASvE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE9C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK7C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE7C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAErE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAM3C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EACtD,GAAG,EAAE,CAAC,EACN,GAAG,IAAI,EAAE,CAAC,EAAE,GACX,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAQZ;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,IAAI,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,CAAC,EACtD,GAAG,EAAE,CAAC,EACN,GAAG,IAAI,EAAE,CAAC,EAAE,GACX,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAMZ;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAC1B,KAAK,EAAE,CAAC,EAAE,EACV,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,GACjB,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAQb;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,MAAU,GAAG,MAAM,EAAE,CAM5E;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAsB,KAAK,CAAC,CAAC,EAC3B,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EACpB,OAAO,GAAE,MAAU,EACnB,KAAK,GAAE,MAAa,GACnB,OAAO,CAAC,CAAC,CAAC,CAQZ;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAE/C;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,SAAS,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,CAAC,CAEpE;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,GAAG,CAEzE"}