uuid-apikey/index.d.ts

A Base32-Crockford encoded API Key generator, validator, and converter to turn UUIDs into human readable API Keys

declare module 'uuid-apikey';

export interface UUIDOptions {
  noDashes: boolean;
}

export interface ApiKeyInfo {
  uuid: string;
  apiKey: string;
}

declare class UUIDAPIKey {
  checkDashes(positions: number[], str: string): boolean;
  isUUID(uuid: string): boolean;
  isAPIKey(apiKey: string): boolean;
  toAPIKey(uuid: string, options?: Partial<UUIDOptions>): string;
  toUUID(apiKey: string): string;
  check(apiKey: string, uuid: string): boolean;
  create(options?: Partial<UUIDOptions>): ApiKeyInfo;
}

declare let obj: UUIDAPIKey;
export default obj;