Skip to content

ShardBus

Defined in: packages/sharding/src/bus.ts:76

Cross-shard messaging: send, broadcast, and request/reply over a ShardBusTransport.

new ShardBus(shardId, channelName, options?): ShardBus

Defined in: packages/sharding/src/bus.ts:110

Creates a shard bus.

number

Shard ID.

string

Application-specific channel name.

ShardBusOptions = {}

ShardBus

If shard ID is invalid.

If channel name is empty.

readonly channelName: string

Defined in: packages/sharding/src/bus.ts:92

BroadcastChannel name used by this bus.

broadcast<T>(type, data): string

Defined in: packages/sharding/src/bus.ts:177

Broadcasts to all other shards.

T

string

Message type.

T

Payload.

string

Unique message ID.


broadcastRequest<R, T>(type, data, options?): Promise<ShardReply<R>[]>

Defined in: packages/sharding/src/bus.ts:241

Sends a request to every other shard and collects replies until expected have arrived or timeoutMs elapses. A timeout or a shard going away does not reject; a closed bus, a blank type or too many pending requests does.

R = unknown

T = unknown

string

T

number

number

Promise<ShardReply<R>[]>


close(): void

Defined in: packages/sharding/src/bus.ts:300

Closes the transport.

void

Nothing.


off<T>(type, handler): this

Defined in: packages/sharding/src/bus.ts:140

Removes a message handler.

T

string

Message type.

ShardMessageHandler<T> | ((data, message) => unknown)

Handler callback.

this

This bus.


offError(handler): this

Defined in: packages/sharding/src/bus.ts:164

Removes a handler error listener.

ShardBusErrorHandler

Error listener.

this

This bus.


on<T>(type, handler): this

Defined in: packages/sharding/src/bus.ts:131

Registers a message handler.

T

string

Message type.

ShardMessageHandler<T>

Handler callback.

this

This bus.

If type or handler is invalid.


onError(handler): this

Defined in: packages/sharding/src/bus.ts:157

Registers a listener for errors thrown or rejected by message handlers. Without one, handler errors are isolated and dropped.

ShardBusErrorHandler

Error listener.

this

This bus.

If handler is invalid.


request<R, T>(target, type, data, timeoutMs?): Promise<R>

Defined in: packages/sharding/src/bus.ts:210

Sends a request to one shard and resolves with its handler’s result.

R = unknown

T = unknown

number

string

T

number = 5000

Promise<R>

If the handler failed or no reply arrives in time.


respond<T, R>(type, handler): this

Defined in: packages/sharding/src/bus.ts:186

Registers a handler that answers requests of type. Its return value (or thrown error) is sent back to the requesting shard. Received code is never evaluated.

T

R

string

(data, message) => R | Promise<R>

this

This bus.


send<T>(target, type, data): string

Defined in: packages/sharding/src/bus.ts:169

Sends a targeted shard message.

T

number

Target shard ID.

string

Message type.

T

Payload.

string

Unique message ID.