mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-07-22 01:50:03 +00:00
Added support for LiosK's UUID.js
This commit is contained in:
88
UUID/UUID.d.ts
vendored
Normal file
88
UUID/UUID.d.ts
vendored
Normal file
@@ -0,0 +1,88 @@
|
||||
// Type definitions for UUID.js core-1.0
|
||||
// Project: https://github.com/LiosK/UUID.js
|
||||
// Definitions by: Jason Jarrett <https://github.com/staxmanade/>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
declare module UUID {
|
||||
|
||||
interface UUIDStatic {
|
||||
|
||||
/**
|
||||
* The simplest function to get an UUID string.
|
||||
* @returns {string} A version 4 UUID string.
|
||||
*/
|
||||
generate(): string;
|
||||
|
||||
/**
|
||||
* Generates a version 4 {@link UUID}.
|
||||
* @returns {UUID} A version 4 {@link UUID} object.
|
||||
* @since 3.0
|
||||
*/
|
||||
genV4(): UUID;
|
||||
|
||||
|
||||
/**
|
||||
* Generates a version 1 {@link UUID}.
|
||||
* @returns {UUID} A version 1 {@link UUID} object.
|
||||
* @since 3.0
|
||||
*/
|
||||
genV1(): UUID;
|
||||
|
||||
/**
|
||||
* Converts hexadecimal UUID string to an {@link UUID} object.
|
||||
* @param {string} strId UUID hexadecimal string representation ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx").
|
||||
* @returns {UUID} {@link UUID} object or null.
|
||||
* @since 3.0
|
||||
*/
|
||||
parse(uuid: string): UUID;
|
||||
|
||||
|
||||
/**
|
||||
* Re-initializes version 1 UUID state.
|
||||
* @since 3.0
|
||||
*/
|
||||
resetState(): void;
|
||||
|
||||
/**
|
||||
* Reinstalls {@link UUID.generate} method to emulate the interface of UUID.js version 2.x.
|
||||
* @since 3.1
|
||||
* @deprecated Version 2.x. compatible interface is not recommended.
|
||||
*/
|
||||
makeBackwardCompatible(): void;
|
||||
}
|
||||
|
||||
interface UUIDArray<T> extends Array<T> {
|
||||
timeLow: string;
|
||||
timeMid: string;
|
||||
timeHiAndVersion: string;
|
||||
clockSeqHiAndReserved: string;
|
||||
clockSeqLow: string;
|
||||
node: string;
|
||||
}
|
||||
|
||||
interface UUID {
|
||||
intFields: UUIDArray<number>;
|
||||
bitFields: UUIDArray<string>;
|
||||
hexFields: UUIDArray<string>;
|
||||
version: number;
|
||||
bitString: string;
|
||||
hexString: string;
|
||||
urn: string;
|
||||
|
||||
|
||||
/**
|
||||
* Tests if two {@link UUID} objects are equal.
|
||||
* @param {UUID} uuid
|
||||
* @returns {bool} True if two {@link UUID} objects are equal.
|
||||
*/
|
||||
equals(uuid: UUID): boolean;
|
||||
|
||||
/**
|
||||
* Returns UUID string representation.
|
||||
* @returns {string} {@link UUID#hexString}.
|
||||
*/
|
||||
toString(): string;
|
||||
}
|
||||
}
|
||||
|
||||
declare var UUID: UUID.UUIDStatic;
|
||||
Reference in New Issue
Block a user