UNPKG

598 BTypeScriptView Raw
1/**
2 * generates a UID factory
3 * @internal
4 * @example
5 * const uid = generateUID();
6 * uid(object) = 1;
7 * uid(object) = 1;
8 * uid(anotherObject) = 2;
9 */
10export declare const generateUID: () => (item: any, index?: number) => string;
11/**
12 * @name uid
13 * returns an UID associated with {item}
14 * @param {Object} item - object to generate UID for
15 * @param {Number} index, a fallback index
16 * @example
17 * uid(object) == 1;
18 * uid(object) == 1;
19 * uid(anotherObject) == 2;
20 * uid("not object", 42) == 42
21 *
22 * @see {@link useUID}
23 */
24export declare const uid: (item: any, index?: number) => string;