@vuetify/v0 0.0.16 → 0.0.20

package/dist/index-CjzlIAtF.d.mts

@@ -0,0 +1,296 @@
+import { n as DeepPartial } from "./index-4jSy8KIt.mjs";
+
+//#region src/utilities/helpers.d.ts
+
+/**
+ * Checks if a value is a function
+ *
+ * @param item The value to check
+ * @returns True if the value is a function
+ *
+ * @example
+ * ```ts
+ * isFunction(() => {})  // true
+ * isFunction('string')  // false
+ * ```
+ */
+declare function isFunction(item: unknown): item is Function;
+/**
+ * Checks if a value is a string
+ *
+ * @param item The value to check
+ * @returns True if the value is a string
+ *
+ * @example
+ * ```ts
+ * isString('hello')  // true
+ * isString(123)      // false
+ * ```
+ */
+declare function isString(item: unknown): item is string;
+/**
+ * Checks if a value is a number
+ *
+ * @param item The value to check
+ * @returns True if the value is a number (including NaN)
+ *
+ * @example
+ * ```ts
+ * isNumber(123)       // true
+ * isNumber(NaN)       // true
+ * isNumber('123')     // false
+ * ```
+ *
+ * @see {@link isNaN} to check for NaN specifically
+ */
+declare function isNumber(item: unknown): item is number;
+/**
+ * Checks if a value is a boolean
+ *
+ * @param item The value to check
+ * @returns True if the value is a boolean
+ *
+ * @example
+ * ```ts
+ * isBoolean(true)   // true
+ * isBoolean(false)  // true
+ * isBoolean(0)      // false
+ * ```
+ */
+declare function isBoolean(item: unknown): item is boolean;
+/**
+ * Checks if a value is a plain object (excludes null and arrays)
+ *
+ * @param item The value to check
+ * @returns True if the value is a plain object
+ *
+ * @remarks
+ * Returns false for null and arrays, even though `typeof null === 'object'`
+ * and `typeof [] === 'object'` in JavaScript.
+ *
+ * @example
+ * ```ts
+ * isObject({})        // true
+ * isObject({ a: 1 })  // true
+ * isObject(null)      // false
+ * isObject([])        // false
+ * ```
+ *
+ * @see {@link isArray} to check for arrays
+ * @see {@link isNull} to check for null
+ */
+declare function isObject(item: unknown): item is Record<string, unknown>;
+/**
+ * Checks if a value is an array
+ *
+ * @param item The value to check
+ * @returns True if the value is an array
+ *
+ * @example
+ * ```ts
+ * isArray([])        // true
+ * isArray([1, 2, 3]) // true
+ * isArray('string')  // false
+ * ```
+ */
+declare function isArray(item: unknown): item is unknown[];
+/**
+ * Checks if a value is null
+ *
+ * @param item The value to check
+ * @returns True if the value is null
+ *
+ * @example
+ * ```ts
+ * isNull(null)      // true
+ * isNull(undefined) // false
+ * ```
+ *
+ * @see {@link isUndefined} to check for undefined
+ * @see {@link isNullOrUndefined} to check for either
+ */
+declare function isNull(item: unknown): item is null;
+/**
+ * Checks if a value is null or undefined
+ *
+ * @param item The value to check
+ * @returns True if the value is null or undefined
+ *
+ * @remarks
+ * Uses loose equality (`== null`) which matches both null and undefined.
+ *
+ * @example
+ * ```ts
+ * isNullOrUndefined(null)      // true
+ * isNullOrUndefined(undefined) // true
+ * isNullOrUndefined(0)         // false
+ * isNullOrUndefined('')        // false
+ * ```
+ *
+ * @see {@link isNull} to check for null only
+ * @see {@link isUndefined} to check for undefined only
+ */
+declare function isNullOrUndefined(item: unknown): item is null | undefined;
+/**
+ * Checks if a value is undefined
+ *
+ * @param item The value to check
+ * @returns True if the value is undefined
+ *
+ * @example
+ * ```ts
+ * isUndefined(undefined) // true
+ * isUndefined(null)      // false
+ * ```
+ *
+ * @see {@link isNull} to check for null
+ * @see {@link isNullOrUndefined} to check for either
+ */
+declare function isUndefined(item: unknown): item is undefined;
+/**
+ * Checks if a value is a primitive (string, number, or boolean)
+ *
+ * @param item The value to check
+ * @returns True if the value is a string, number, or boolean
+ *
+ * @example
+ * ```ts
+ * isPrimitive('hello') // true
+ * isPrimitive(123)     // true
+ * isPrimitive(true)    // true
+ * isPrimitive({})      // false
+ * isPrimitive(null)    // false
+ * ```
+ */
+declare function isPrimitive(item: unknown): item is string | number | boolean;
+/**
+ * Checks if a value is a symbol
+ *
+ * @param item The value to check
+ * @returns True if the value is a symbol
+ *
+ * @example
+ * ```ts
+ * isSymbol(Symbol('test')) // true
+ * isSymbol('symbol')       // false
+ * ```
+ */
+declare function isSymbol(item: unknown): item is symbol;
+/**
+ * Checks if a value is NaN (Not a Number)
+ *
+ * @param item The value to check
+ * @returns True if the value is NaN
+ *
+ * @remarks
+ * Uses `Number.isNaN()` which only returns true for the actual NaN value,
+ * unlike the global `isNaN()` which coerces the argument to a number first.
+ *
+ * @example
+ * ```ts
+ * isNaN(NaN)         // true
+ * isNaN(123)         // false
+ * isNaN('hello')     // false (unlike global isNaN)
+ * isNaN(undefined)   // false (unlike global isNaN)
+ * ```
+ *
+ * @see {@link isNumber} to check if a value is a number type
+ */
+declare function isNaN(item: unknown): item is number;
+/**
+ * Deeply merges source objects into a target object
+ *
+ * @param target The target object to merge into (will be mutated)
+ * @param sources One or more source objects to merge from
+ * @returns The mutated target object
+ *
+ * @remarks
+ * - Mutates the target object in place
+ * - Nested objects are recursively merged
+ * - Arrays are replaced, not merged
+ * - Primitives from sources overwrite target values
+ *
+ * @example
+ * ```ts
+ * const target = { a: 1, b: { c: 2 } }
+ * mergeDeep(target, { b: { d: 3 } })
+ * // target is now { a: 1, b: { c: 2, d: 3 } }
+ *
+ * // Multiple sources
+ * mergeDeep({}, { a: 1 }, { b: 2 }) // { a: 1, b: 2 }
+ *
+ * // Arrays are replaced
+ * mergeDeep({ arr: [1, 2] }, { arr: [3] }) // { arr: [3] }
+ * ```
+ */
+declare function mergeDeep<T extends object>(target: T, ...sources: DeepPartial<T>[]): T;
+/**
+ * Generates a random 7-character alphanumeric ID
+ *
+ * @returns A random string of 7 characters (a-z, 0-9)
+ *
+ * @remarks
+ * Uses `Math.random()` converted to base-36. Not cryptographically secure.
+ * Suitable for unique keys in UI components, not for security purposes.
+ *
+ * @example
+ * ```ts
+ * genId() // 'k7x9m2p'
+ * genId() // 'a3b8c1d'
+ * ```
+ */
+declare function genId(): string;
+/**
+ * Clamps a value between a minimum and maximum
+ *
+ * @param value The value to clamp
+ * @param min The minimum value (default: 0)
+ * @param max The maximum value (default: 1)
+ * @returns The clamped value
+ *
+ * @example
+ * ```ts
+ * clamp(5, 0, 10)  // 5
+ * clamp(-5, 0, 10) // 0
+ * clamp(15, 0, 10) // 10
+ * ```
+ */
+declare function clamp(value: number, min?: number, max?: number): number;
+/**
+ * Creates an array of sequential numbers
+ *
+ * @param length The length of the array to create
+ * @param start The starting index (default: 0)
+ * @returns An array of sequential numbers
+ *
+ * @example
+ * ```ts
+ * range(3)     // [0, 1, 2]
+ * range(3, 1)  // [1, 2, 3]
+ * range(5, 10) // [10, 11, 12, 13, 14]
+ * range(0)     // []
+ * ```
+ */
+declare function range(length: number, start?: number): number[];
+/**
+ * Debounces a function call by the specified delay
+ *
+ * @param fn The function to debounce
+ * @param delay The delay in milliseconds
+ * @returns A debounced function with clear and immediate methods
+ *
+ * @example
+ * ```ts
+ * const debouncedFn = debounce(() => console.log('called'), 500)
+ * debouncedFn()        // Will call after 500ms
+ * debouncedFn.clear()  // Cancel pending call
+ * debouncedFn.immediate() // Call immediately
+ * ```
+ */
+declare function debounce<T extends (...args: any[]) => any>(fn: T, delay: number): {
+  (...args: Parameters<T>): void;
+  clear(): void;
+  immediate(...args: Parameters<T>): void;
+};
+//#endregion
+export { range as _, isBoolean as a, isNull as c, isObject as d, isPrimitive as f, mergeDeep as g, isUndefined as h, isArray as i, isNullOrUndefined as l, isSymbol as m, debounce as n, isFunction as o, isString as p, genId as r, isNaN as s, clamp as t, isNumber as u };