@types/uid-generator NPM

Installation

npm install --save @types/uid-generator

Summary

This package contains type definitions for uid-generator (https://github.com/nwoltman/node-uid-generator).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/uid-generator.

index.d.ts

// Type definitions for uid-generator 2.0
// Project: https://github.com/nwoltman/node-uid-generator
// Definitions by: KyleChine <https://github.com/kylechine>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

interface UIDGeneratorInstance {
  readonly bitSize: number;
  readonly uidLength: number;
  readonly baseEncoding: string;
  readonly base: number;
  generateSync(): string;
  generate(): Promise<string>;
  generate(cb: (error: Error|null, uid: string) => any): void;
}

interface UIDGeneratorClass {
  new (bitSize?: number, baseEncoding?: string): UIDGeneratorInstance;
  new (baseEncoding?: string): UIDGeneratorInstance;
  readonly BASE16: '0123456789abcdef';
  readonly BASE36: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ';
  readonly BASE58: '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
  readonly BASE62: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz';
  readonly BASE66: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~';
  readonly BASE71: "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!'()*-._~";
  readonly BASE94: "!\"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmnopqrstuvwxyz{|}~";
}

declare const UIDGenerator: UIDGeneratorClass;

export = UIDGenerator;