@types/node-uuid/README.md

TypeScript definitions for node-uuid

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node-uuid/index.d.ts)
````ts
/// <reference types="node" />

export as namespace uuid;

export interface UUIDOptions {
    /**
     * Node id as Array of 6 bytes (per 4.1.6).
     * Default: Randomly generated ID. See note 1.
     */
    node?: any[] | undefined;

    /**
     * (Number between 0 - 0x3fff) RFC clock sequence.
     * Default: An internally maintained clockseq is used.
     */
    clockseq?: number | undefined;

    /**
     * (Number | Date) Time in milliseconds since unix Epoch.
     * Default: The current time is used.
     */
    msecs?: number | Date | undefined;

    /**
     * (Number between 0-9999) additional time, in 100-nanosecond units. Ignored if msecs is unspecified.
     * Default: internal uuid counter is used, as per 4.2.1.2.
     */
    nsecs?: number | undefined;
}

export interface UUID {
    v1(options?: UUIDOptions): string;
    v1(options?: UUIDOptions, buffer?: number[], offset?: number): number[];

    v4(options?: UUIDOptions): string;
    v4(options?: UUIDOptions, buffer?: number[], offset?: number): number[];

    parse(id: string, buffer?: number[], offset?: number): number[];

    unparse(buffer: number[], offset?: number): string;
}

export function v1(options?: UUIDOptions): string;
export function v1(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
export function v1(options?: UUIDOptions, buffer?: Buffer, offset?: number): Buffer;

export function v4(options?: UUIDOptions): string;
export function v4(options?: UUIDOptions, buffer?: number[], offset?: number): number[];
export function v4(options?: UUIDOptions, buffer?: Buffer, offset?: number): Buffer;

export function parse(id: string, buffer?: number[], offset?: number): number[];
export function parse(id: string, buffer?: Buffer, offset?: number): Buffer;

export function unparse(buffer: number[], offset?: number): string;
export function unparse(buffer: Buffer, offset?: number): string;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Jeff May](https://github.com/jeffmay).