49 lines
1.5 KiB
TypeScript
49 lines
1.5 KiB
TypeScript
/**
|
||
* By default, Nano ID uses hardware random bytes generation for security
|
||
* and low collision probability. If you are not so concerned with security,
|
||
* you can use it for environments without hardware random generators.
|
||
*
|
||
* ```js
|
||
* import { nanoid } from 'nanoid/non-secure'
|
||
* const id = nanoid() //=> "Uakgb_J5m9g-0JDMbcJqLJ"
|
||
* ```
|
||
*
|
||
* @module
|
||
*/
|
||
|
||
/**
|
||
* Generate URL-friendly unique ID. This method uses the non-secure
|
||
* predictable random generator with bigger collision probability.
|
||
*
|
||
* ```js
|
||
* import { nanoid } from 'nanoid/non-secure'
|
||
* model.id = nanoid() //=> "Uakgb_J5m9g-0JDMbcJqL"
|
||
* ```
|
||
*
|
||
* @param size Size of the ID. The default size is 21.
|
||
* @typeparam Type The ID type to replace `string` with some opaque type.
|
||
* @returns A random string.
|
||
*/
|
||
export function nanoid<Type extends string>(size?: number): Type
|
||
|
||
/**
|
||
* Generate a unique ID based on a custom alphabet.
|
||
* This method uses the non-secure predictable random generator
|
||
* with bigger collision probability.
|
||
*
|
||
* @param alphabet Alphabet used to generate the ID.
|
||
* @param defaultSize Size of the ID. The default size is 21.
|
||
* @typeparam Type The ID type to replace `string` with some opaque type.
|
||
* @returns A random string generator.
|
||
*
|
||
* ```js
|
||
* import { customAlphabet } from 'nanoid/non-secure'
|
||
* const nanoid = customAlphabet('0123456789абвгдеё', 5)
|
||
* model.id = nanoid() //=> "8ё56а"
|
||
* ```
|
||
*/
|
||
export function customAlphabet<Type extends string>(
|
||
alphabet: string,
|
||
defaultSize?: number
|
||
): (size?: number) => Type
|