@andrew_l/snowflake 0.3.22 → 0.4.0

package/dist/index.d.mts

@@ -2,55 +2,55 @@
  * 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;
+  /**
+   * 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;
+  /**
+   * 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.
@@ -80,152 +80,157 @@ declare var MAX_INCREMENT: number;
  * @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;
+  /**
+   * 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 _timestamp;
+  private __buf;
+  private _packBuffer;
+  private _packBigInt;
+  private _unpackBuffer;
+  private _unpackBigInt;
+  /**
+   * @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 };
+export { DeconstructedSnowflake, MAX_INCREMENT, MAX_PROCESS_ID, MAX_WORKER_ID, Snowflake, SnowflakeOptions };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":["id","timestamp","workerId","processId","increment","epoch","Date","decode","Uint8Array","DeconstructedSnowflake","_epoch","_increment","_processId","_workerId","_timestamp","__buf","_packBuffer","_packBigInt","_unpackBuffer","_unpackBigInt","constructor","SnowflakeOptions","opts","value","_createSavePoint","setLowest","setHighest","withLowest","Result","Snowflake","instance","fn","withHighest","generate","generateBufferUnsafe","generateBuffer","deconstruct","timestampFrom","compare","a","b","bufferFrom"],"sources":["../src/Snowflake.d.ts"],"mappings":"AAGA;;;AAAA,UAAiB,sBAAA;EAIbA;;;EAAAA,EAAAA;EAgBAI;;;EAZAH,SAAAA;EAqBa;;;EAjBbC,QAAAA;EAqBAG;;;EAjBAF,SAAAA;EAiCAA;;AAAS;EA7BTC,SAAAA;EAkCoC;;;EA9BpCC,KAAAA;AAAAA;;;;UAKa,gBAAA;EAiCE;;;EA7BfA,KAAAA,oBAAyB,IAAI;EA6BO;AAgBxC;;;;EAvCID,SAAAA;EA4EkB;;;;EAvElBF,QAAAA;EAmI+C;;;;EA9H/CC,SAAAA;AAAAA;;;;YAKe,aAAA;;;;YAIA,cAAA;;;;YAIA,aAAA;;;;;;;;;;;;;;;;cAgBE,SAAA;EAyCbE;;;EArCJE,MAAAA,GAASP,EAAAA,oBAAsB,UAAA,KAAe,sBAAA;EAkD1CE;;;;EAAAA,iBA7CaQ,MAAAA;EA2DHa;;;;EAAAA,QAtDNZ,UAAAA;EAyEGiB;;;;EAAAA,QApEHhB,UAAAA;EAoE6DgB;;;;EAAAA,QA/D7Df,SAAAA;EAyEqDe;;;EAAAA,QArErDd,UAAAA;EAAAA,QACAC,KAAAA;EAAAA,QACAC,WAAAA;EAAAA,QACAC,WAAAA;EAAAA,QACAC,aAAAA;EAAAA,QACAC,aAAAA;EA+EyCX;;;EA3EjDY,WAAAA,CAAYE,IAAAA,EAAM,gBAAA,GAAmB,IAAA;EAqFMd;;;EAAAA,IAjFvCH,KAAAA;EA4F2CI;;;EAAAA,IAxF3CN,SAAAA;EAsGGmC;;;;EAAAA,IAjGHnC,SAAAA,CAAUoB,KAAAA;EAqGPkB;;;EAAAA,IAjGHvC,QAAAA;EAiGiD;;;;EAAA,IA5FjDA,QAAAA,CAASqB,KAAAA;;;;MAITnB,SAAAA;;;;;MAKAA,SAAAA,CAAUmB,KAAAA;EAAAA,QACNC,gBAAAA;;;;EAIRC,SAAAA;;;;EAIAC,UAAAA;;;;;;;;;;EAUAC,UAAAA,qBAA+BI,EAAAA,GAAKD,QAAAA,EAAU,SAAA,KAAc,MAAA,GAAS,MAAA;;;;;;;;;;EAUrEE,WAAAA,qBAAgCD,EAAAA,GAAKD,QAAAA,EAAU,SAAA,KAAc,MAAA,GAAS,MAAA;;;;EAItEG,QAAAA,CAAShC,SAAAA,GAAY,IAAA;;;;;;;;;;;EAWrBiC,oBAAAA,CAAqBjC,SAAAA,GAAY,IAAA,YAAgB,UAAA;;;;;;;;;;EAUjDkC,cAAAA,CAAelC,SAAAA,GAAY,IAAA,YAAgB,UAAA;;;;;;;;;;;EAW3CmC,WAAAA,CAAYpC,EAAAA,oBAAsB,UAAA,GAAa,sBAAA;;;;;;EAM/CqC,aAAAA,CAAcrC,EAAAA,oBAAsB,UAAA;;;;;;;;SAQ7BsC,OAAAA,CAAQC,CAAAA,oBAAqB,UAAA,EAAYC,CAAAA,oBAAqB,UAAA;;;;SAI9DC,UAAAA,CAAWlB,KAAAA,oBAAyB,UAAA;AAAA"}