Blame view

node_modules/nanoid/async/index.d.ts 1.47 KB
7820380e   “wangming”   1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
  /**
   * Generate secure URL-friendly unique ID. The non-blocking version.
   *
   * By default, the ID will have 21 symbols to have a collision probability
   * similar to UUID v4.
   *
   * ```js
   * import { nanoid } from 'nanoid/async'
   * nanoid().then(id => {
   *   model.id = id
   * })
   * ```
   *
   * @param size Size of the ID. The default size is 21.
   * @returns A promise with a random string.
   */
  export function nanoid(size?: number): Promise<string>
  
  /**
   * A low-level function.
   * Generate secure unique ID with custom alphabet. The non-blocking version.
   *
   * Alphabet must contain 256 symbols or less. Otherwise, the generator
   * will not be secure.
   *
   * @param alphabet Alphabet used to generate the ID.
   * @param defaultSize Size of the ID. The default size is 21.
   * @returns A function that returns a promise with a random string.
   *
   * ```js
   * import { customAlphabet } from 'nanoid/async'
   * const nanoid = customAlphabet('0123456789абвгдеё', 5)
   * nanoid().then(id => {
   *   model.id = id //=> "8ё56а"
   * })
   * ```
   */
  export function customAlphabet(
    alphabet: string,
    defaultSize?: number
  ): (size?: number) => Promise<string>
  
  /**
   * Generate an array of random bytes collected from hardware noise.
   *
   * ```js
   * import { random } from 'nanoid/async'
   * random(5).then(bytes => {
   *   bytes //=> [10, 67, 212, 67, 89]
   * })
   * ```
   *
   * @param bytes Size of the array.
   * @returns A promise with a random bytes array.
   */
  export function random(bytes: number): Promise<Uint8Array>