Class Publisher<TMessage>

Type Parameters

TMessage extends Document

Index

Constructors

Methods

Constructors

constructor

new Publisher<TMessage extends Document>(
collection: Collection<TMessage>,
options?: PublisherOptions,
): Publisher<TMessage>
Type Parameters
- TMessage extends Document
Parameters
- collection: Collection<TMessage>
- options: PublisherOptions = {}
Returns Publisher<TMessage>
- Defined in src/Publisher.ts:18

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/Publisher.ts:56

publish

publish(
message: OptionalUnlessRequiredId<TMessage>,
options?: InsertOneOptions,
): Promise<null | InferIdType<TMessage>>
Publishes the given message, returning the inserted message ID. Ignores message duplicates, returning null in that case. Can be used inside transactions (same options as MongoDB insertOne).
Parameters
- message: OptionalUnlessRequiredId<TMessage>
- Optionaloptions: InsertOneOptions
Returns Promise<null | InferIdType<TMessage>>
- Defined in src/Publisher.ts:34