Skip to main content

Interface: DataBusClient

Defined in: src/sdk/data/DataBus.ts:8

Experimental

A provider of subscribable DataItems.

Extended by

Methods

of()

of<R, I>(): TypedDataBusClient<R, I>

Defined in: src/sdk/data/DataBus.ts:17

Experimental

Retrieves a typed data bus client that provides data items described by a record type.

Type Parameters

Type ParameterDefault typeDescription
R extends Record<string, any>Record<never, never>A record describing the data items available from the typed client to return. The name of each property in the record defines one label that can be used to retrieve a data item, and the type of the property defines the value type of data items retrieved using the label (under any index).
I extends numbernumberThe indexes for which data items are available from the client.

Returns

TypedDataBusClient<R, I>

A typed data bus client that provides data items described by the specified record type.