Interface Transport

Minimal transport contract the store needs. Every binding-supplied adapter MUST implement it; the store doesn't care what's underneath.

interface Transport {
    publish<T>(topic: string, payload: T): void;
    subscribe<T>(
        topic: string,
        handler: TransportSubscribeHandler<T>,
    ): () => void;
}

Index

Methods

publish subscribe

Methods

publish

publish<T>(topic: string, payload: T): void
Publish a JSON-serialisable payload on topic. Returns synchronously.
Type Parameters
- T
Parameters
- topic: string
- payload: T
Returns void
- Defined in packages/core/src/types/transport.ts:37

subscribe<T>(topic: string, handler: TransportSubscribeHandler<T>): () => void
Subscribe to a topic. Returns an unsubscribe function.
Type Parameters
- T
Parameters
- topic: string
- handler: TransportSubscribeHandler<T>
Returns () => void
- Defined in packages/core/src/types/transport.ts:39