Logo for jsDocs.io

@types/node-uuid

  • Version 0.0.32
  • Published
  • 6.43 kB
  • 1 dependency
  • MIT license

Install

npm i @types/node-uuid
yarn add @types/node-uuid
pnpm add @types/node-uuid

Overview

TypeScript definitions for node-uuid

Index

Functions

Interfaces

Functions

function parse

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

    function unparse

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

      function v1

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

        function v4

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

          Interfaces

          interface UUID

          interface UUID {}

            method parse

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

              method unparse

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

                method v1

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

                  method v4

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

                    interface UUIDOptions

                    interface UUIDOptions {}

                      property clockseq

                      clockseq?: number | undefined;

                      • (Number between 0 - 0x3fff) RFC clock sequence. Default: An internally maintained clockseq is used.

                      property msecs

                      msecs?: number | Date | undefined;

                      • (Number | Date) Time in milliseconds since unix Epoch. Default: The current time is used.

                      property node

                      node?: any[] | undefined;

                      • Node id as Array of 6 bytes (per 4.1.6). Default: Randomly generated ID. See note 1.

                      property nsecs

                      nsecs?: number | 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.

                      Package Files (1)

                      Dependencies (1)

                      Dev Dependencies (0)

                      No dev dependencies.

                      Peer Dependencies (0)

                      No peer dependencies.

                      Badge

                      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/node-uuid.

                      • Markdown
                        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/node-uuid)
                      • HTML
                        <a href="https://www.jsdocs.io/package/@types/node-uuid"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>