Clients

Covers Engine 2.0.0

useDartwic

Returns the DARTWIC client context for the nearest DartwicProvider.

Import

import { useDartwic } from "@voit-systems/dartwic.react-client";

Declaration

export function useDartwic()

Returns

DartwicContextValue — Client operations, connection state, and channel subscription helpers.

Context value

FieldTypeDescription
clientTempestWebClientUnderlying TEMPEST web client.
channelStoreobjectSubscription store used by the channel hooks.
channelsobjectCurrent live channel payloads keyed by channel name.
lastOperationobject|nullResult summary for the most recently tracked operation.
connectfunctionConnects to an engine and verifies runtime compatibility.
disconnectfunctionDisconnects and clears local channel state.
operationfunctionCalls a TEMPEST operation.
bindTelemetryHandlerfunctionRegisters a telemetry handler for a topic prefix.
unbindTelemetryHandlerfunctionRemoves a telemetry handler.
sendTelemetryfunctionPublishes a telemetry message.
addChannelToTelemetryfunctionSubscribes to one RAPID channel.
addChannelsToTelemetryfunctionSubscribes to multiple RAPID channels.
removeChannelFromTelemetryfunctionUnsubscribes from one RAPID channel.
removeChannelsFromTelemetryfunctionUnsubscribes from multiple RAPID channels.
queryChannelRangefunctionQueries recorded values for one channel.
upsertChannelfunctionWrites a value or metadata field by flat RAPID channel name.