Class Message<T>

constructor

• new Message<T>(
      params: {
          adaptor: Adaptor<T>;
          channelId: string;
          content: Buffer;
          id: bigint;
          isUnlocked: boolean;
          numAttempts: number;
          schema: string;
          state: Buffer<ArrayBufferLike> | null;
      },
  ): queue.Message<T>

  Type Parameters

  • T

  Parameters

  • params: {
        adaptor: Adaptor<T>;
        channelId: string;
        content: Buffer;
        id: bigint;
        isUnlocked: boolean;
        numAttempts: number;
        schema: string;
        state: Buffer<ArrayBufferLike> | null;
    }

  Returns queue.Message<T>

ReadonlychannelId

Readonlycontent

Readonlyid

ReadonlyisUnlocked

ReadonlynumAttempts

Readonlystate

defer

• defer(
      params: {
          databaseClient: T;
          dequeueAt?: number;
          state?: Buffer<ArrayBufferLike>;
      },
  ): Promise<command.message.defer.Result>

  Parameters

  • params: { databaseClient: T; dequeueAt?: number; state?: Buffer<ArrayBufferLike> }

  Returns Promise<command.message.defer.Result>

heartbeat

• heartbeat(
      params: { databaseClient: T; lockMs: number },
  ): Promise<command.message.heartbeat.Result>

  Parameters

  • params: { databaseClient: T; lockMs: number }

  Returns Promise<command.message.heartbeat.Result>

retire

• retire(params: { databaseClient: T }): Promise<command.message.retire.Result>

  Parameters

  • params: { databaseClient: T }

  Returns Promise<command.message.retire.Result>