Skip to content

Class: Producer<D> ​

Defined in: glide-mq/src/producer.ts:74

Type Parameters ​

Type ParameterDefault type
Dany

Constructors ​

Constructor ​

ts
new Producer<D>(name, opts): Producer<D>;

Defined in: glide-mq/src/producer.ts:87

Parameters ​

ParameterType
namestring
optsProducerOptions

Returns ​

Producer<D>

Properties ​

name ​

ts
readonly name: string;

Defined in: glide-mq/src/producer.ts:75

Accessors ​

isClosed ​

Get Signature ​

ts
get isClosed(): boolean;

Defined in: glide-mq/src/producer.ts:534

Returns true if close() has been called.

Returns ​

boolean

Methods ​

add() ​

ts
add(
   name,
   data,
   opts?
): Promise&lt;string | null>;

Defined in: glide-mq/src/producer.ts:274

Add a single job to the queue. Returns the job ID (string) or null if deduplicated/collision.

Parameters ​

ParameterType
namestring
dataD
opts?JobOptions

Returns ​

Promise<string | null>


addBulk() ​

ts
addBulk(jobs): Promise<(string | null)[]>;

Defined in: glide-mq/src/producer.ts:375

Add multiple jobs in a single pipeline round trip. Returns an array of job IDs (string or null for dedup/collision).

Parameters ​

ParameterType
jobsobject[]

Returns ​

Promise<(string | null)[]>


close() ​

ts
close(): Promise&lt;void>;

Defined in: glide-mq/src/producer.ts:542

Close the producer. If the client was created by this producer, it is destroyed. If an external client was provided, it is not closed.

Returns ​

Promise<void>

Released under the Apache-2.0 License.