Skip to main content

Class: QueueClient

Defined in: libs/sdk/src/queue.ts:19

Constructors​

new QueueClient()​

new QueueClient(http): QueueClient

Defined in: libs/sdk/src/queue.ts:20

Parameters​

http​

HttpClient

Returns​

QueueClient

Methods​

create()​

create(options): Promise<RindaQueue>

Defined in: libs/sdk/src/queue.ts:22

Parameters​

options​

CreateQueueOptions

Returns​

Promise<RindaQueue>

delete()​

delete(queueId): Promise<void>

Defined in: libs/sdk/src/queue.ts:52

Parameters​

queueId​

string

Returns​

Promise<void>

get()​

get(queueId): Promise<RindaQueue>

Defined in: libs/sdk/src/queue.ts:34

Parameters​

queueId​

string

Returns​

Promise<RindaQueue>

list()​

list(): Promise<RindaQueue[]>

Defined in: libs/sdk/src/queue.ts:30

Returns​

Promise<RindaQueue[]>

update()​

update(queueId, options): Promise<RindaQueue>

Defined in: libs/sdk/src/queue.ts:45

Changes a queue's settings, and returns it as it now stands.

Only the fields given are touched; anything omitted is left alone. Which fields can change is set by UpdateQueueOptions — a queue's name, region, FIFO-ness and encryption are fixed at creation.

Parameters​

queueId​

string

options​

UpdateQueueOptions

Returns​

Promise<RindaQueue>