Installation

npm install --save @types/node-uuid

Summary

This package contains type definitions for node-uuid (https://github.com/broofa/node-uuid).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-uuid.

index.d.ts

1/// <reference types="node" />
2
3export as namespace uuid;
4
5export interface UUIDOptions {
6    /**
7     * Node id as Array of 6 bytes (per 4.1.6).
8     * Default: Randomly generated ID. See note 1.
9     */
10    node?: any[] | undefined;
11
12    /**
13     * (Number between 0 - 0x3fff) RFC clock sequence.
14     * Default: An internally maintained clockseq is used.
15     */
16    clockseq?: number | undefined;
17
18    /**
19     * (Number | Date) Time in milliseconds since unix Epoch.
20     * Default: The current time is used.
21     */
22    msecs?: number | Date | undefined;
23
24    /**
25     * (Number between 0-9999) additional time, in 100-nanosecond units. Ignored if msecs is unspecified.
26     * Default: internal uuid counter is used, as per 4.2.1.2.
27     */
28    nsecs?: number | undefined;
29}
30
31export interface UUID {
32    v1(options?: UUIDOptions): string;
33    v1(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
34
35    v4(options?: UUIDOptions): string;
36    v4(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
37
38    parse(id: string, buffer?: number[], offset?: number): number[];
39
40    unparse(buffer: number[], offset?: number): string;
41}
42
43export function v1(options?: UUIDOptions): string;
44export function v1(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
45export function v1(options?: UUIDOptions, buffer?: Buffer, offset?: number): Buffer;
46
47export function v4(options?: UUIDOptions): string;
48export function v4(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
49export function v4(options?: UUIDOptions, buffer?: Buffer, offset?: number): Buffer;
50
51export function parse(id: string, buffer?: number[], offset?: number): number[];
52export function parse(id: string, buffer?: Buffer, offset?: number): Buffer;
53
54export function unparse(buffer: number[], offset?: number): string;
55export function unparse(buffer: Buffer, offset?: number): string;
56

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:39 GMT
• Dependencies: @types/node

Credits

These definitions were written by Jeff May.