21 lines
785 B
TypeScript
21 lines
785 B
TypeScript
import { BackendFactory, QueueEventsProducerOptions } from '../interfaces';
|
|
import { QueueBase } from './queue-base';
|
|
/**
|
|
* The QueueEventsProducer class is used for publishing custom events.
|
|
*/
|
|
export declare class QueueEventsProducer extends QueueBase {
|
|
constructor(name: string, opts?: QueueEventsProducerOptions, backendFactory?: BackendFactory);
|
|
/**
|
|
* Publish custom event to be processed in QueueEvents.
|
|
* @param argsObj - Event payload
|
|
* @param maxEvents - Max quantity of events to be saved
|
|
*/
|
|
publishEvent<T extends {
|
|
eventName: string;
|
|
}>(argsObj: T, maxEvents?: number): Promise<void>;
|
|
/**
|
|
* Closes the connection and returns a promise that resolves when the connection is closed.
|
|
*/
|
|
close(): Promise<void>;
|
|
}
|