@types/uuid-1345/index.d.ts

TypeScript definitions for uuid-1345

/// <reference types="node" />

export interface UUID {
    version: string;
    variant: string;
    toString(): string;
    toBuffer(): Buffer;
}

type UuidTypes = string | Buffer | UUID;
interface ASCIICallback {
    (error: string, result: string): void;
}

interface BinaryCallback {
    (error: string, result: Buffer): void;
}

interface ObjectCallback {
    (error: string, result: UUID): void;
}

export declare var namespace: {
    dns: UUID;
    url: UUID;
    oid: UUID;
    x500: UUID;
};

export declare function check(uuid: string | Buffer): { version?: number | undefined; variant: string; format: string };
export declare function parse(uuid: string): Buffer;
export declare function stringify(uuid: Buffer): string;

export declare function v1(): string;
export declare function v1(options: { mac?: boolean | undefined }): string;
export declare function v1(options: { encoding: "ascii"; mac?: boolean | undefined }): string;
export declare function v1(options: { encoding: "binary"; mac?: boolean | undefined }): Buffer;
export declare function v1(options: { encoding: "object"; mac?: boolean | undefined }): UUID;
export declare function v1(options: { mac?: boolean | undefined }, callback: ASCIICallback): void;
export declare function v1(options: { encoding: "ascii"; mac?: boolean | undefined }, callback: ASCIICallback): void;
export declare function v1(options: { encoding: "binary"; mac?: boolean | undefined }, callback: BinaryCallback): void;
export declare function v1(options: { encoding: "object"; mac?: boolean | undefined }, callback: ObjectCallback): void;
export declare function v1(callback: ASCIICallback): void;

export declare function v3(options: { namespace: UuidTypes; name: string }): string;
export declare function v3(options: { encoding: "ascii"; namespace: UuidTypes; name: string }): string;
export declare function v3(options: { encoding: "binary"; namespace: UuidTypes; name: string }): Buffer;
export declare function v3(options: { encoding: "object"; namespace: UuidTypes; name: string }): UUID;
export declare function v3(options: { namespace: UuidTypes; name: string }, callback: ASCIICallback): void;
export declare function v3(
    options: { encoding: "ascii"; namespace: UuidTypes; name: string },
    callback: ASCIICallback,
): void;
export declare function v3(
    options: { encoding: "binary"; namespace: UuidTypes; name: string },
    callback: BinaryCallback,
): void;
export declare function v3(
    options: { encoding: "object"; namespace: UuidTypes; name: string },
    callback: ObjectCallback,
): void;

export declare function v4(): string;
export declare function v4(options: { encoding: "ascii" }): string;
export declare function v4(options: { encoding: "binary" }): Buffer;
export declare function v4(options: { encoding: "object" }): UUID;
export declare function v4(options: { encoding: "ascii" }, callback: ASCIICallback): void;
export declare function v4(options: { encoding: "binary" }, callback: BinaryCallback): void;
export declare function v4(options: { encoding: "object" }, callback: ObjectCallback): void;
export declare function v4(callback: ASCIICallback): void;

export declare function v4fast(): string;
export declare function v4fast(options: { encoding: "ascii" }): string;
export declare function v4fast(options: { encoding: "binary" }): Buffer;
export declare function v4fast(options: { encoding: "object" }): UUID;
export declare function v4fast(options: { encoding: "ascii" }, callback: ASCIICallback): void;
export declare function v4fast(options: { encoding: "binary" }, callback: BinaryCallback): void;
export declare function v4fast(options: { encoding: "object" }, callback: ObjectCallback): void;
export declare function v4fast(callback: ASCIICallback): void;

export declare function v5(options: { namespace: UuidTypes; name: string }): string;
export declare function v5(options: { encoding: "ascii"; namespace: UuidTypes; name: string }): string;
export declare function v5(options: { encoding: "binary"; namespace: UuidTypes; name: string }): Buffer;
export declare function v5(options: { encoding: "object"; namespace: UuidTypes; name: string }): UUID;
export declare function v5(options: { namespace: UuidTypes; name: string }, callback: ASCIICallback): void;
export declare function v5(
    options: { encoding: "ascii"; namespace: UuidTypes; name: string },
    callback: ASCIICallback,
): void;
export declare function v5(
    options: { encoding: "binary"; namespace: UuidTypes; name: string },
    callback: BinaryCallback,
): void;
export declare function v5(
    options: { encoding: "object"; namespace: UuidTypes; name: string },
    callback: ObjectCallback,
): void;