Skip to content

Latest commit

 

History

History
70 lines (41 loc) · 1.86 KB

README.md

File metadata and controls

70 lines (41 loc) · 1.86 KB

@letsgo/queue

@letsgo/queue

This package provides a way to enqueue messages to be processed by the LetsGo worker.

Table of contents

Interfaces

Functions

Functions

enqueue

▸ enqueue(message, options?): Promise<EnqueueResult>

Enqueues a message to be processed by the LetsGo worker. If the LETSGO_LOCAL_QUEUE_URL environment variable is set, the message is sent to the specified URL with an HTTP POST instead of being enqueued to AWS SQS. This environment variable is used in the local development scenario to allow the worker component to run behind a lightweight HTTP server on the developer's machine.

Parameters

Name Type Description
message Message The message to enqueue
options? EnqueueOptions Options for enqueueing the message

Returns

Promise<EnqueueResult>

Enqeue result, including SQS message Id.

Defined in

index.ts:211

listLetsGoQueues

▸ listLetsGoQueues(region, deployment?): Promise<string[]>

Lists all SQS queue URLs created by LetsGo in a given region and optionally to support a given deployment.

Parameters

Name Type Description
region string AWS region
deployment? string LetsGo deployment name

Returns

Promise<string[]>

Array of matching SQS queue URLs

Defined in

index.ts:45