Class FakeSqsGateway

constructor

• new FakeSqsGateway(): FakeSqsGateway

  Returns FakeSqsGateway

ReadonlyCalls

Now

AddQueue

• AddQueue(
      url: string,
      options: {
          Attributes?: Record<string, string>;
          Fifo: boolean;
          VisibilityTimeoutSeconds?: number;
      },
  ): this

  Parameters

  • url: string
  • options: {
        Attributes?: Record<string, string>;
        Fifo: boolean;
        VisibilityTimeoutSeconds?: number;
    }

  Returns this

Advance

• Advance(seconds: number): void

  Parameters

  • seconds: number

  Returns void

ChangeVisibility

• ChangeVisibility(
      queueUrl: string,
      receiptHandle: string,
      seconds: number,
  ): Promise<boolean>

  False when the receipt handle no longer owns an in-flight message.

  Parameters

  • queueUrl: string
  • receiptHandle: string
  • seconds: number

  Returns Promise<boolean>

Delete

• Delete(queueUrl: string, receiptHandle: string): Promise<boolean>

  False when the receipt handle is no longer valid.

  Parameters

  • queueUrl: string
  • receiptHandle: string

  Returns Promise<boolean>

FailNext

• FailNext(op: FakeSqsOperation, error: Error): void

  Parameters

  • op: FakeSqsOperation
  • error: Error

  Returns void

GetAttributes

• GetAttributes(queueUrl: string): Promise<Record<string, string>>

  All queue attributes; null when the queue does not exist.

  Parameters

  • queueUrl: string

  Returns Promise<Record<string, string>>

Messages

• Messages(url: string): FakeSqsMessage[]

  Undeleted messages, oldest first.

  Parameters

  • url: string

  Returns FakeSqsMessage[]

Receive

• Receive(request: SqsReceiveRequest): Promise<SqsReceivedMessage[]>

  Returns [] when the signal aborts the long poll.

  Parameters

  • request: SqsReceiveRequest

  Returns Promise<SqsReceivedMessage[]>

Send

• Send(request: SqsSendRequest): Promise<string>

  Returns the new SQS MessageId.

  Parameters

  • request: SqsSendRequest

  Returns Promise<string>