### Convert uuidv7 to Uuid25 representations Source: https://github.com/liosk/uuidv7/blob/main/docs/index.html Demonstrates converting a uuidv7 object to various string representations using the Uuid25 library. Ensure both uuidv7 and uuid25 are installed. ```javascript import { uuidv7obj } from "uuidv7"; import { Uuid25 } from "uuid25"; const uuid25 = Uuid25.fromBytes(uuidv7obj().bytes); console.log(uuid25.value); // e.g., "03a2s63x4x0b9mev9e88i7gpm" console.log(uuid25.toHex()); // e.g., "0189f8068f1a79b6bb21123c6accc25a" console.log(uuid25.toHyphenated()); // e.g., "0189f806-8f1a-79b6-bb21-123c6accc25a" console.log(uuid25.toBraced()); // e.g., "{0189f806-8f1a-79b6-bb21-123c6accc25a}" console.log(uuid25.toUrn()); // e.g., "urn:uuid:0189f806-8f1a-79b6-bb21-123c6accc25a" ``` -------------------------------- ### Convert UUIDv7 Bytes to Uuid25 Representations Source: https://github.com/liosk/uuidv7/blob/main/README.md Generates a UUIDv7 object and converts its byte array to multiple string formats using Uuid25. Ensure both uuidv7 and uuid25 libraries are installed. ```javascript import { uuidv7obj } from "uuidv7"; import { Uuid25 } from "uuid25"; const uuid25 = Uuid25.fromBytes(uuidv7obj().bytes); console.log(uuid25.value); // e.g., "03a2s63x4x0b9mev9e88i7gpm" console.log(uuid25.toHex()); // e.g., "0189f8068f1a79b6bb21123c6accc25a" console.log(uuid25.toHyphenated()); // e.g., "0189f806-8f1a-79b6-bb21-123c6accc25a" console.log(uuid25.toBraced()); // e.g., "{0189f806-8f1a-79b6-bb21-123c6accc25a}" console.log(uuid25.toUrn()); // e.g., "urn:uuid:0189f806-8f1a-79b6-bb21-123c6accc25a" ``` -------------------------------- ### Generate UUIDv7 in Deno Source: https://github.com/liosk/uuidv7/blob/main/docs/index.html Use the unpkg import path to include and use the uuidv7 function in a Deno environment. This allows for direct browser-like imports. ```javascript import { uuidv7 } from "https://unpkg.com/uuidv7@^1"; const result = uuidv7(); // e.g., "017fe537-bb13-7c35-b52a-cb5490cce7be" ``` -------------------------------- ### Generate UUIDs via CLI Source: https://github.com/liosk/uuidv7/blob/main/docs/index.html Utilize npx to run the uuidv7 command-line tool for generating UUIDs. Specify the -n flag to generate multiple UUIDs at once. ```bash $ npx uuidv7 0189f7e5-c883-7106-8272-ccb7fcba0575 $ npx uuidv7 -n 4 0189f7ea-ae2c-7809-8aeb-b819cf5e9e7f 0189f7ea-ae2f-72b9-9be8-9c3c5a60214f 0189f7ea-ae2f-72b9-9be8-9c3d224082ef 0189f7ea-ae2f-72b9-9be8-9c3e3e8abae8 ``` -------------------------------- ### Generate UUIDv7 in Browsers and Deno Source: https://github.com/liosk/uuidv7/blob/main/README.md Use the unpkg CDN to import and use the uuidv7 function in browser or Deno environments. Ensure you are using the correct import path for your environment. ```javascript import { uuidv7 } from "https://unpkg.com/uuidv7@^1"; const result = uuidv7(); // e.g., "017fe537-bb13-7c35-b52a-cb5490cce7be" ``` -------------------------------- ### Utilize V7Generator for Advanced UUID Generation Source: https://github.com/liosk/uuidv7/blob/main/docs/index.html Instantiate V7Generator for managing separate counter states and handling potential clock rollbacks. The generateOrAbort() method ensures monotonic order or throws an error. ```javascript import { V7Generator } from "uuidv7"; const g = new V7Generator(); const x = g.generate(); const y = g.generateOrAbort(); if (y === undefined) { throw new Error("The clock went backwards by ten seconds!"); } console.assert(x.compareTo(y) < 0); ``` -------------------------------- ### Custom UUIDv7 Generator with State Source: https://github.com/liosk/uuidv7/blob/main/README.md Instantiate V7Generator for managing separate counter states and handling potential clock rollbacks. The generateOrAbort method provides a guarantee of monotonic order. ```javascript import { V7Generator } from "uuidv7"; const g = new V7Generator(); const x = g.generate(); const y = g.generateOrAbort(); if (y === undefined) { throw new Error("The clock went backwards by ten seconds!"); } console.assert(x.compareTo(y) < 0); ``` -------------------------------- ### generateOrAbortWithTs Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/V7Generator.html Generates a new UUIDv7 object from the provided Unix timestamp in milliseconds. Returns undefined if a significant timestamp rollback is detected. This method is equivalent to the main `generateOrAbort` function but accepts a custom timestamp. ```APIDOC ## generateOrAbortWithTs ### Description Generates a new UUIDv7 object from the `unixTsMs` passed, or returns `undefined` upon significant timestamp rollback. This method is equivalent to [generateOrAbort](#generateorabort) except that it takes a custom timestamp. ### Method Not applicable (function signature) ### Endpoint Not applicable (function signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters * **unixTsMs** (number) - The Unix timestamp in milliseconds. ### Returns [UUID](UUID.html) | undefined ### Throws RangeError if `unixTsMs` is not a 48-bit unsigned integer. ### Defined in index.ts:366 ``` -------------------------------- ### uuidv7() - Generate UUIDv7 Source: https://github.com/liosk/uuidv7/blob/main/docs/functions/uuidv7.html This snippet shows how to use the uuidv7 function to generate a UUIDv7 string. ```APIDOC ## uuidv7() ### Description Generates a UUIDv7 string. ### Method N/A (This is a function call, not an HTTP endpoint) ### Endpoint N/A ### Parameters None ### Request Example ```javascript const newUuid = uuidv7(); console.log(newUuid); ``` ### Response #### Success Response - **uuid** (string) - The generated 8-4-4-4-12 canonical hexadecimal string representation ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). #### Response Example ```json { "uuid": "1ed491f0-7c5a-7000-8000-000000000000" } ``` ``` -------------------------------- ### Generate UUIDv7 via CLI Source: https://github.com/liosk/uuidv7/blob/main/README.md Utilize the command-line interface to generate UUIDv7 identifiers. The -n flag can be used to generate multiple UUIDs at once. ```bash $ npx uuidv7 0189f7e5-c883-7106-8272-ccb7fcba0575 $ $ npx uuidv7 -n 4 0189f7ea-ae2c-7809-8aeb-b819cf5e9e7f 0189f7ea-ae2f-72b9-9be8-9c3c5a60214f 0189f7ea-ae2f-72b9-9be8-9c3d224082ef 0189f7ea-ae2f-72b9-9be8-9c3e3e8abae8 ``` -------------------------------- ### Generate UUIDv4 Source: https://github.com/liosk/uuidv7/blob/main/README.md Import and use the uuidv4 function to generate a UUIDv4 string. This function is available from the same library. ```javascript import { uuidv4 } from "uuidv7"; const result = uuidv4(); // e.g., "83229083-75c3-4da5-8378-f88ef1a2bcd1" ``` -------------------------------- ### UUIDv7 fromFieldsV7 Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/UUID.html Builds a UUIDv7 byte array from its constituent field values. ```APIDOC ## Static fromFieldsV7 ### Description Builds a byte array from UUIDv7 field values. ### Method Static method ### Parameters #### Path Parameters - **unixTsMs** (number) - Required - A 48-bit `unix_ts_ms` field value. - **randA** (number) - Required - A 12-bit `rand_a` field value. - **randBHi** (number) - Required - The higher 30 bits of 62-bit `rand_b` field value. - **randBLo** (number) - Required - The lower 32 bits of 62-bit `rand_b` field value. ### Returns UUID[] ### Throws RangeError if any field value is out of the specified range. ``` -------------------------------- ### generateOrAbortCore Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/V7Generator.html Generates a new UUIDv7 object from the provided Unix timestamp in milliseconds. Returns undefined if a significant timestamp rollback is detected. This is a deprecated method that accepts rollbackAllowance as an argument. ```APIDOC ## generateOrAbortCore ### Description Generates a new UUIDv7 object from the `unixTsMs` passed, or returns `undefined` upon significant timestamp rollback. This method is a deprecated version of [generateOrAbortWithTs](#generateorabortwithts) that accepts the `rollbackAllowance` parameter as an argument, rather than using the generator-level parameter. ### Method Not applicable (function signature) ### Endpoint Not applicable (function signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters * **unixTsMs** (number) - The Unix timestamp in milliseconds. * **rollbackAllowance** (number) - The amount of `unixTsMs` rollback that is considered significant. A suggested value is `10_000` (milliseconds). ### Returns [UUID](UUID.html) | undefined ### Throws RangeError if `unixTsMs` is not a 48-bit unsigned integer. ### Deprecated Since v1.2.0. Use [generateOrAbortWithTs](#generateorabortwithts) instead. ### Defined in index.ts:440 ``` -------------------------------- ### Generate UUIDv7 in JavaScript Source: https://github.com/liosk/uuidv7/blob/main/docs/index.html Import and use the uuidv7 function to generate a UUID version 7. This is the primary method for creating new UUIDs. ```javascript import { uuidv7 } from "uuidv7"; const result = uuidv7(); // e.g., "017fe537-bb13-7c35-b52a-cb5490cce7be" ``` -------------------------------- ### generateOrResetWithTs Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/V7Generator.html Generates a new UUIDv7 object from the provided Unix timestamp in milliseconds. Resets the generator if a significant timestamp rollback is detected. This method is equivalent to the main `generate` function but accepts a custom timestamp. ```APIDOC ## generateOrResetWithTs ### Description Generates a new UUIDv7 object from the `unixTsMs` passed, or resets the generator upon significant timestamp rollback. This method is equivalent to [generate](#generate) except that it takes a custom timestamp. ### Method Not applicable (function signature) ### Endpoint Not applicable (function signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters * **unixTsMs** (number) - The Unix timestamp in milliseconds. ### Returns [UUID](UUID.html) ### Throws RangeError if `unixTsMs` is not a 48-bit unsigned integer. ### Defined in index.ts:347 ``` -------------------------------- ### uuidv7obj Function Source: https://github.com/liosk/uuidv7/blob/main/docs/functions/uuidv7obj.html Generates a UUIDv7 object. ```APIDOC ## uuidv7obj() ### Description Generates a UUIDv7 object. ### Method N/A (This is a function call, not an HTTP endpoint) ### Endpoint N/A ### Parameters None ### Request Example ```javascript const uuid = uuidv7obj(); ``` ### Response #### Success Response - **UUID** (object) - A generated UUIDv7 object. #### Response Example ```json { "example": "a-uuid-string-representation" } ``` ### Source Defined in index.ts:533 ``` -------------------------------- ### UUIDv7 ofInner Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/UUID.html Creates a UUID object from an internal byte array representation. ```APIDOC ## Static ofInner ### Description Creates an object from the internal representation, a 16-byte byte array containing the binary UUID representation in the big-endian byte order. This method does NOT shallow-copy the argument, and thus the created object holds the reference to the underlying buffer. ### Method Static method ### Parameters #### Path Parameters - **bytes** (Readonly) - Required - A 16-byte byte array. ### Returns UUID ### Throws TypeError if the length of the argument is not 16. ``` -------------------------------- ### UUIDv4 Object Generation Source: https://github.com/liosk/uuidv7/blob/main/docs/functions/uuidv4obj.html This function generates a UUIDv4 object. ```APIDOC ## Function uuidv4obj ### Description Generates a UUIDv4 object. ### Method N/A (This is a function call, not an HTTP endpoint) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response - **UUID** (object) - A generated UUIDv4 object. #### Response Example N/A (The return type is an object, not a JSON structure in this context) ``` -------------------------------- ### Generate UUIDv4 in JavaScript Source: https://github.com/liosk/uuidv7/blob/main/docs/index.html Import and use the uuidv4 function to generate a UUID version 4. This provides a different type of UUID generation. ```javascript import { uuidv4 } from "uuidv7"; const result = uuidv4(); // e.g., "83229083-75c3-4da5-8378-f88ef1a2bcd1" ``` -------------------------------- ### Generate UUID Objects Source: https://github.com/liosk/uuidv7/blob/main/docs/index.html Use uuidv7obj() and uuidv4obj() to generate UUIDs as 16-byte byte arrays. These objects provide methods for variant and version checks, equality comparison, and string conversion. ```javascript import { uuidv7obj } from "uuidv7"; const object = uuidv7obj(); console.log(object.bytes); // Uint8Array(16) [ ... ] console.log(String(object)); // e.g., "017fea6b-b877-7aef-b422-57db9ed15e9d" console.assert(object.getVariant() === "VAR_10"); console.assert(object.getVersion() === 7); console.assert(object.clone().equals(object)); console.assert(object.compareTo(uuidv7obj()) < 0); ``` -------------------------------- ### V7Generator Class Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/V7Generator.html The V7Generator class encapsulates the monotonic counter state for generating UUIDs. It offers methods to manage the generation process, ensuring UUIDs are monotonically increasing. ```APIDOC ## Class V7Generator ### Description Encapsulates the monotonic counter state. This class provides APIs to utilize a separate counter state from that of the global generator used by [uuidv7](../functions/uuidv7.html) and [uuidv7obj](../functions/uuidv7obj.html). In addition to the default [generate](#generate) method, this class has [generateOrAbort](#generateorabort) that is useful to absolutely guarantee the monotonically increasing order of generated UUIDs. See their respective documentation for details. ### Constructor #### new V7Generator(randomNumberGenerator?: { nextUint32(): number }): V7Generator Creates a generator object with the default random number generator, or with the specified one if passed as an argument. The specified random number generator should be cryptographically strong and securely seeded. ##### Parameters - **randomNumberGenerator** (object) - Optional - An object with a `nextUint32` method. - **nextUint32** (function) - Required - Returns a 32-bit random unsigned integer. ##### Returns - **V7Generator** - A new instance of V7Generator. ### Methods #### generate(): UUID Generates a new UUIDv7 object from the current timestamp, or resets the generator upon significant timestamp rollback. This method returns a monotonically increasing UUID by reusing the previous timestamp even if the up-to-date timestamp is smaller than the immediately preceding UUID's. However, when such a clock rollback is considered significant (by default, more than ten seconds), this method resets the generator and returns a new UUID based on the given timestamp, breaking the increasing order of UUIDs. See [generateOrAbort](#generateorabort) for the other mode of generation and [generateOrResetWithTs](#generateorresetwithts) for the variant accepting a custom timestamp. ##### Returns - **UUID** - The generated UUID. #### generateOrAbort(): UUID | undefined Generates a new UUIDv7 object from the current timestamp, or returns `undefined` upon significant timestamp rollback. This method returns a monotonically increasing UUID by reusing the previous timestamp even if the up-to-date timestamp is smaller than the immediately preceding UUID's. However, when such a clock rollback is considered significant (by default, more than ten seconds), this method aborts and returns `undefined` immediately. See [generate](#generate) for the other mode of generation and [generateOrAbortWithTs](#generateorabortwithts) for the variant accepting a custom timestamp. ##### Returns - **UUID | undefined** - The generated UUID or undefined if a significant timestamp rollback occurred. ``` -------------------------------- ### Generate UUIDv7 in Node.js Source: https://github.com/liosk/uuidv7/blob/main/README.md Import and use the uuidv7 function to generate a UUIDv7 string. This is the primary method for generating UUIDv7 identifiers. ```javascript import { uuidv7 } from "uuidv7"; const result = uuidv7(); // e.g., "017fe537-bb13-7c35-b52a-cb5490cce7be" ``` -------------------------------- ### uuidv4 Function Source: https://github.com/liosk/uuidv7/blob/main/docs/functions/uuidv4.html Generates a UUIDv4 string. The function returns a canonical hexadecimal string representation of the UUID. ```APIDOC ## uuidv4() ### Description Generates a UUIDv4 string. ### Method N/A (This is a function call, not an HTTP endpoint) ### Endpoint N/A ### Parameters None ### Request Example ```json { "example": "uuidv4()" } ``` ### Response #### Success Response (string) - **uuid** (string) - The 8-4-4-4-12 canonical hexadecimal string representation ("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"). #### Response Example ```json { "example": "123e4567-e89b-12d3-a456-426614174000" } ``` ``` -------------------------------- ### Generate UUIDv7 Object Representation Source: https://github.com/liosk/uuidv7/blob/main/README.md Use uuidv7obj() to generate a UUIDv7 as a 16-byte byte array object. This object provides methods for byte access, string conversion, and comparison. ```javascript import { uuidv7obj } from "uuidv7"; const object = uuidv7obj(); console.log(object.bytes); // Uint8Array(16) [ ... ] console.log(String(object)); // e.g., "017fea6b-b877-7aef-b422-57db9ed15e9d" console.assert(object.getVariant() === "VAR_10"); console.assert(object.getVersion() === 7); console.assert(object.clone().equals(object)); console.assert(object.compareTo(uuidv7obj()) < 0); ``` -------------------------------- ### generateOrResetCore Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/V7Generator.html Generates a new UUIDv7 object from the provided Unix timestamp in milliseconds. Resets the generator if a significant timestamp rollback is detected. This is a deprecated method that accepts rollbackAllowance as an argument. ```APIDOC ## generateOrResetCore ### Description Generates a new UUIDv7 object from the `unixTsMs` passed, or resets the generator upon significant timestamp rollback. This method is a deprecated version of [generateOrResetWithTs](#generateorresetwithts) that accepts the `rollbackAllowance` parameter as an argument, rather than using the generator-level parameter. ### Method Not applicable (function signature) ### Endpoint Not applicable (function signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters * **unixTsMs** (number) - The Unix timestamp in milliseconds. * **rollbackAllowance** (number) - The amount of `unixTsMs` rollback that is considered significant. A suggested value is `10_000` (milliseconds). ### Returns [UUID](UUID.html) ### Throws RangeError if `unixTsMs` is not a 48-bit unsigned integer. ### Deprecated Since v1.2.0. Use [generateOrResetWithTs](#generateorresetwithts) instead. ### Defined in index.ts:415 ``` -------------------------------- ### UUIDv7 parse Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/UUID.html Parses a UUID string into a byte array representation. ```APIDOC ## Static parse ### Description Builds a byte array from a string representation. This method accepts the following formats: 32-digit hexadecimal format without hyphens, 8-4-4-4-12 hyphenated format, hyphenated format with surrounding braces, RFC 9562 URN format. Leading and trailing whitespaces represent an error. ### Method Static method ### Parameters #### Path Parameters - **uuid** (string) - Required - The UUID string to parse. ### Returns UUID ### Throws SyntaxError if the argument could not parse as a valid UUID string. ``` -------------------------------- ### UUID Class Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/UUID.html The UUID class represents a UUID as a 16-byte byte array and provides methods for various operations. ```APIDOC ## Class UUID Represents a UUID as a 16-byte byte array. * Defined in [index.ts:13](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L13) ### Properties * [bytes](#bytes) ### Methods * [clone](#clone) * [compareTo](#compareto) * [equals](#equals) * [getVariant](#getvariant) * [getVersion](#getversion) * [isMax](#ismax) * [isNil](#isnil) * [toHex](#tohex) * [toJSON](#tojson) * [toString](#tostring) * [fromFieldsV7](#fromfieldsv7) * [ofInner](#ofinner) * [parse](#parse) ## Properties ### `Readonly` bytes[](#bytes) bytes: Readonly The 16-byte byte array representation. * Defined in [index.ts:15](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L15) ## Methods ### clone[](#clone) * clone(): UUID[](#clone-1) Creates an object from `this`. #### Returns UUID * Defined in [index.ts:230](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L230) ### compareTo[](#compareto) * compareTo(other: UUID): number[](#compareto-1) Returns a negative integer, zero, or positive integer if `this` is less than, equal to, or greater than `other`, respectively. #### Parameters * other: UUID #### Returns number * Defined in [index.ts:243](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L243) ### equals[](#equals) * equals(other: UUID): boolean[](#equals-1) Returns true if `this` is equivalent to `other`. #### Parameters * other: UUID #### Returns boolean * Defined in [index.ts:235](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L235) ### getVariant[](#getvariant) * getVariant(): "VAR_0" | "VAR_10" | "VAR_110" | "VAR_RESERVED" | "NIL" | "MAX"[](#getvariant-1) Reports the variant field value of the UUID or, if appropriate, "NIL" or "MAX". For convenience, this method reports "NIL" or "MAX" if `this` represents the Nil or Max UUID, although the Nil and Max UUIDs are technically subsumed under the variants `0b0` and `0b111`, respectively. #### Returns "VAR_0" | "VAR_10" | "VAR_110" | "VAR_RESERVED" | "NIL" | "MAX" * Defined in [index.ts:188](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L188) ### getVersion[](#getversion) * getVersion(): number | undefined[](#getversion-1) Returns the version field value of the UUID or `undefined` if the UUID does not have the variant field value of `0b10`. #### Returns number | undefined * Defined in [index.ts:215](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L215) ### isMax[](#ismax) * isMax(): boolean[](#ismax-1) Returns `true` if `this` is the Max UUID. #### Returns boolean * Defined in [index.ts:225](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L225) ### isNil[](#isnil) * isNil(): boolean[](#isnil-1) Returns `true` if `this` is the Nil UUID. #### Returns boolean * Defined in [index.ts:220](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L220) ### toHex[](#tohex) * toHex(): string[](#tohex-1) #### Returns string The 32-digit hexadecimal representation without hyphens (`0189dcd553117d408db09496a2eef37b`). * Defined in [index.ts:166](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L166) ### toJSON[](#tojson) * toJSON(): string[](#tojson-1) #### Returns string The 8-4-4-4-12 canonical hexadecimal string representation. * Defined in [index.ts:176](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L176) ### toString[](#tostring) * toString(): string[](#tostring-1) #### Returns string The 8-4-4-4-12 canonical hexadecimal string representation (`0189dcd5-5311-7d40-8db0-9496a2eef37b`). * Defined in [index.ts:150](https://github.com/LiosK/uuidv7/blob/v1.2.1/src/index.ts#L150) ``` -------------------------------- ### setRollbackAllowance Source: https://github.com/liosk/uuidv7/blob/main/docs/classes/V7Generator.html Sets the rollback allowance parameter for the UUID generator. This parameter defines the threshold for significant timestamp rollback. ```APIDOC ## setRollbackAllowance ### Description Sets the `rollbackAllowance` parameter of the generator. The `rollbackAllowance` parameter specifies the amount of `unixTsMs` rollback that is considered significant. The default value is `10_000` (milliseconds). See the [generate](#generate) or [generateOrAbort](#generateorabort) documentation for the treatment of the significant rollback. ### Method Not applicable (function signature) ### Endpoint Not applicable (function signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters * **rollbackAllowance** (number) - The amount of `unixTsMs` rollback that is considered significant. ### Returns void ### Defined in index.ts:296 ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.