azure-storage/typings/node-uuid/node-uuid.d.ts

Microsoft Azure Storage Client Library for Node.js

// Type definitions for node-uuid.js
// Project: https://github.com/broofa/node-uuid
// Definitions by: Jeff May <https://github.com/jeffmay>
// Definitions: https://github.com/borisyankov/DefinitelyTyped

/// <reference path="../node/node.d.ts" />

interface UUIDOptions {

  /**
   * Node id as Array of 6 bytes (per 4.1.6).
   * Default: Randomly generated ID. See note 1.
   */
  node: any[];

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

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

  /**
   * (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;
}

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

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

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

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

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

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

declare module "node-uuid" {
  var uuid: UUID;
  export = uuid;
}