@andrew_l/snowflake 0.3.22 → 0.4.1

package/dist/index.d.ts

@@ -1,231 +0,0 @@
-/**
- * Object returned by Snowflake#deconstruct
- */
-interface DeconstructedSnowflake {
-    /**
-     * The id as a number
-     */
-    id: bigint;
-    /**
-     * The timestamp stored in the snowflake
-     */
-    timestamp: number;
-    /**
-     * The worker id stored in the snowflake
-     */
-    workerId: number;
-    /**
-     * The process id stored in the snowflake
-     */
-    processId: number;
-    /**
-     * The increment stored in the snowflake
-     */
-    increment: number;
-    /**
-     * The epoch to use in the snowflake
-     */
-    epoch: number;
-}
-/**
- * Options for Snowflake
- */
-interface SnowflakeOptions {
-    /**
-     * Timestamp or date of the snowflake to generate
-     */
-    epoch: number | bigint | Date;
-    /**
-     * The increment to use
-     * @default 0
-     * @remark keep in mind that this number is auto-incremented between generate calls
-     */
-    increment?: number | bigint;
-    /**
-     * The worker ID to use, will be truncated to 5 bits (0-31)
-     * @default 0
-     */
-    workerId?: number | bigint;
-    /**
-     * The process ID to use, will be truncated to 5 bits (0-31)
-     * @default 1
-     */
-    processId?: number | bigint;
-}
-/**
- * The maximum value the `workerId` field accepts in snowflakes.
- */
-declare var MAX_WORKER_ID: number;
-/**
- * The maximum value the `processId` field accepts in snowflakes.
- */
-declare var MAX_PROCESS_ID: number;
-/**
- * The maximum value the `increment` field accepts in snowflakes.
- */
-declare var MAX_INCREMENT: number;
-/**
- * A class for generating and deconstructing Twitter snowflakes.
- *
- * A {@link https://developer.twitter.com/en/docs/twitter-ids Twitter snowflake}
- * is a 64-bit unsigned integer with 4 fields that have a fixed epoch value.
- *
- * If we have a snowflake `266241948824764416` we can represent it as binary:
- * ```
- * 64                                          22     17     12          0
- * 000000111011000111100001101001000101000000  00001  00000  000000000000
- *          number of ms since epoch           worker  pid    increment
- * ```
- *
- * @group Main
- */
-declare class Snowflake {
-    /**
-     * Alias for {@link deconstruct}
-     */
-    decode: (id: string | bigint | Uint8Array) => DeconstructedSnowflake;
-    /**
-     * Internal reference of the epoch passed in the constructor
-     * @internal
-     */
-    private readonly _epoch;
-    /**
-     * Internal incrementor for generating snowflakes
-     * @internal
-     */
-    private _increment;
-    /**
-     * The process ID that will be used by default in the generate method
-     * @internal
-     */
-    private _processId;
-    /**
-     * The worker ID that will be used by default in the generate method
-     * @internal
-     */
-    private _workerId;
-    /**
-     * @internal
-     */
-    private _buffer;
-    /**
-     * @param epoch the epoch to use
-     */
-    constructor(opts: SnowflakeOptions | Date | number | bigint);
-    /**
-     * The epoch for this snowflake, as a number
-     */
-    get epoch(): number;
-    /**
-     * Gets the configured process ID
-     */
-    get processId(): number;
-    /**
-     * Sets the process ID that will be used by default for the {@link generate} method
-     * @param value The new value, will be masked with `0b11111`
-     */
-    set processId(value: number | bigint);
-    /**
-     * Gets the configured worker ID
-     */
-    get workerId(): number;
-    /**
-     * Sets the worker ID that will be used by default for the {@link generate} method
-     * @param value The new value, will be masked with `0b11111`
-     */
-    set workerId(value: number | bigint);
-    /**
-     * Get incrementor for generating snowflakes
-     */
-    get increment(): number;
-    /**
-     * Sets the incrementor for generating snowflakes that will be used by default for the {@link generate} method
-     * @param value The new value
-     */
-    set increment(value: number | bigint);
-    private _createSavePoint;
-    /**
-     * Sets most lowest values for generating snowflakes that will be used by default for the {@link generate} method
-     */
-    setLowest(): void;
-    /**
-     * Sets most highest values for generating snowflakes that will be used by default for the {@link generate} method
-     */
-    setHighest(): void;
-    /**
-     * Execute a function in context of most lowest values for generating snowflakes
-     * @example
-     * ```typescript
-     * const epoch = new Date('2000-01-01T00:00:00.000Z');
-     * const snowflake = new Snowflake();
-     * const id = snowflake.withLowest((v) => v.generate(epoch)); // the lowest possible id for that epoch
-     * ```
-     */
-    withLowest<Result = undefined>(fn: (instance: Snowflake) => Result): Result;
-    /**
-     * Execute a function in context of most highest values for generating snowflakes
-     * @example
-     * ```typescript
-     * const epoch = new Date('2000-01-01T00:00:00.000Z');
-     * const snowflake = new Snowflake();
-     * const id = snowflake.withLowest((v) => v.generate(epoch)); // the highest possible id for that epoch
-     * ```
-     */
-    withHighest<Result = undefined>(fn: (instance: Snowflake) => Result): Result;
-    /**
-     * Generates a Snowflake ID as bigint.
-     */
-    generate(timestamp?: Date | number): bigint;
-    /**
-     * Generates a Snowflake ID as a `Uint8Array` buffer.
-     *
-     * ⚠️ Returns a reference to the **same** internal `Uint8Array` instance.
-     * Its contents may be overwritten on the next ID generation call.
-     *
-     * This method is intended for high-performance scenarios where you
-     * immediately transform the buffer (e.g., to base62) before calling again.
-     * Avoid storing or mutating the returned buffer directly.
-     */
-    generateBufferUnsafe(timestamp?: Date | number): Uint8Array;
-    /**
-     * Generates a snowflake given an epoch and optionally a timestamp
-     * @example
-     * ```typescript
-     * const epoch = new Date('2000-01-01T00:00:00.000Z');
-     * const snowflake = new Snowflake({ epoch }).generate();
-     * ```
-     * @returns A unique snowflake as Uint8Array
-     */
-    generateBuffer(timestamp?: Date | number): Uint8Array;
-    /**
-     * Deconstructs a snowflake given a snowflake ID
-     * @param id the snowflake to deconstruct
-     * @returns a deconstructed snowflake
-     * @example
-     * ```typescript
-     * const epoch = new Date('2000-01-01T00:00:00.000Z');
-     * const snowflake = new Snowflake(epoch).deconstruct('3971046231244935168');
-     * ```
-     */
-    deconstruct(id: string | bigint | Uint8Array): DeconstructedSnowflake;
-    /**
-     * Retrieves the timestamp field's value from a snowflake.
-     * @param id The snowflake to get the timestamp value from.
-     * @returns The UNIX timestamp that is stored in `id`.
-     */
-    timestampFrom(id: string | bigint | Uint8Array): number;
-    /**
-     * Returns a number indicating whether a reference snowflake comes before, or after, or is same as the given
-     * snowflake in sort order.
-     * @param a The first snowflake to compare.
-     * @param b The second snowflake to compare.
-     * @returns `-1` if `a` is older than `b`, `0` if `a` and `b` are equals, `1` if `a` is newer than `b`.
-     */
-    static compare(a: string | bigint | Uint8Array, b: string | bigint | Uint8Array): -1 | 0 | 1;
-    /**
-     * Parse value as Uint8Array buffer
-     */
-    static bufferFrom(value: bigint | string): Uint8Array;
-}
-
-export { type DeconstructedSnowflake, MAX_INCREMENT, MAX_PROCESS_ID, MAX_WORKER_ID, Snowflake, type SnowflakeOptions };