Class: Producer<D>

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

Type Parameters

Type Parameter	Default type
D	any

Constructors

Constructor

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

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

Parameters

Parameter	Type
name	string
opts	ProducerOptions

Returns

Producer<D>

Properties

name

readonly name: string;

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

Accessors

isClosed

Get Signature

get isClosed(): boolean;

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

Returns true if close() has been called.

Returns

boolean

Methods

add()

add(
   name, 
   data, 
opts?): Promise<string | null>;

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

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

Parameters

Parameter	Type
name	string
data	D
opts?	JobOptions

Returns

Promise<string | null>

---

addBulk()

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

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

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

Parameters

Parameter	Type
jobs	object[]

Returns

Promise<(string | null)[]>

---

close()

close(): Promise<void>;

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

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>