Directus / @directus/memory / index / BusLocal

Class: BusLocal ​

Implements ​

• Bus

Constructors ​

new BusLocal() ​

new BusLocal(_config): BusLocal

Parameters ​

• _config: Omit<BusConfigLocal, "type">

Returns ​

BusLocal

Defined in ​

packages/memory/src/bus/lib/local.ts:7

Methods ​

publish() ​

publish<T>(channel, payload): Promise<void>

Publish a message to subscribed clients in the given channel

Type Parameters ​

• T = unknown

Parameters ​

• channel: string

Channel to publish to

• payload: T

Value to send to the subscribed clients

Returns ​

Promise<void>

Implementation of ​

Bus.publish

Defined in ​

packages/memory/src/bus/lib/local.ts:11

subscribe() ​

subscribe<T>(channel, callback): Promise<void>

Subscribe to messages in the given channel

Type Parameters ​

• T = unknown

Parameters ​

• channel: string

Channel to subscribe to

• callback: MessageHandler<T>

Payload that was published to the given channel

Returns ​

Promise<void>

Implementation of ​

Bus.subscribe

Defined in ​

packages/memory/src/bus/lib/local.ts:24

unsubscribe() ​

unsubscribe<T>(channel, callback): Promise<void>

Unsubscribe from a channel

Type Parameters ​

• T = unknown

Parameters ​

• channel: string

Channel to unsubscribe from

• callback: MessageHandler<T>

Callback to remove from the stack

Returns ​

Promise<void>

Implementation of ​

Bus.unsubscribe

Defined in ​

packages/memory/src/bus/lib/local.ts:32