UNPKG

2.79 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/node-uuid`
3
4# Summary
5This package contains type definitions for node-uuid.js (https://github.com/broofa/node-uuid).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-uuid.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-uuid/index.d.ts)
10````ts
11// Type definitions for node-uuid.js
12// Project: https://github.com/broofa/node-uuid
13// Definitions by: Jeff May <https://github.com/jeffmay>
14// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
15
16/// <reference types="node" />
17
18export as namespace uuid;
19
20export interface UUIDOptions {
21
22 /**
23 * Node id as Array of 6 bytes (per 4.1.6).
24 * Default: Randomly generated ID. See note 1.
25 */
26 node?: any[] | undefined;
27
28 /**
29 * (Number between 0 - 0x3fff) RFC clock sequence.
30 * Default: An internally maintained clockseq is used.
31 */
32 clockseq?: number | undefined;
33
34 /**
35 * (Number | Date) Time in milliseconds since unix Epoch.
36 * Default: The current time is used.
37 */
38 msecs?: number|Date | undefined;
39
40 /**
41 * (Number between 0-9999) additional time, in 100-nanosecond units. Ignored if msecs is unspecified.
42 * Default: internal uuid counter is used, as per 4.2.1.2.
43 */
44 nsecs?: number | undefined;
45}
46
47export interface UUID {
48 v1(options?: UUIDOptions): string;
49 v1(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
50
51 v4(options?: UUIDOptions): string;
52 v4(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
53
54 parse(id: string, buffer?: number[], offset?: number): number[];
55
56 unparse(buffer: number[], offset?: number): string;
57}
58
59export function v1(options?: UUIDOptions): string;
60export function v1(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
61export function v1(options?: UUIDOptions, buffer?: Buffer, offset?: number): Buffer;
62
63export function v4(options?: UUIDOptions): string;
64export function v4(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
65export function v4(options?: UUIDOptions, buffer?: Buffer, offset?: number): Buffer;
66
67export function parse(id: string, buffer?: number[], offset?: number): number[];
68export function parse(id: string, buffer?: Buffer, offset?: number): Buffer;
69
70export function unparse(buffer: number[], offset?: number): string;
71export function unparse(buffer: Buffer, offset?: number): string;
72
73````
74
75### Additional Details
76 * Last updated: Wed, 07 Jul 2021 00:01:50 GMT
77 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
78 * Global values: `uuid`
79
80# Credits
81These definitions were written by [Jeff May](https://github.com/jeffmay).
82
\No newline at end of file