UNPKG

@vansite/ts-sharetribe-flex-sdk

Version:

This is a TypeScript SDK for Sharetribe Flex API. It reduces the complexity of the API and provides a more user-friendly interface.

39 lines 1.47 kB
/** * @fileoverview Provides the UUID class for handling universally unique identifiers (UUIDs). * This class allows for the creation and validation of UUIDs, using the `uuid` library. */ import { SdkType } from "../types/sdk-types"; declare const UUID_SDK_TYPE = "UUID"; /** * Class representing a UUID (Universally Unique Identifier). * * The UUID class ensures that a valid UUID is created or used, with the option to generate one if none is provided. */ declare class UUID implements SdkType { uuid: string; readonly _sdkType: typeof UUID_SDK_TYPE; /** * Creates an instance of the UUID class. * * @param {string} [uuid] - An optional UUID string. If not provided, a new UUID will be generated. * @example * const id = new UUID(); * console.log(id.toString()); // Outputs a newly generated UUID. * * const predefinedId = new UUID('123e4567-e89b-12d3-a456-426614174000'); * console.log(predefinedId.toString()); // Outputs: '123e4567-e89b-12d3-a456-426614174000' */ constructor(uuid?: string); /** * Converts the UUID instance to its string representation. * * @returns {string} - The string representation of the UUID. * @example * const id = new UUID(); * console.log(id.toString()); // Outputs the UUID as a string. */ toString(): string; } export default UUID; export type UUIDInstance = InstanceType<typeof UUID>; //# sourceMappingURL=UUID.d.ts.map