nusm axolotlnusm
API Reference

Synchronization API

Authenticated source, validator, event, and protocol option contracts.

createBroadcastChannelSyncSource

function createBroadcastChannelSyncSource<TState = unknown>(
  options: BroadcastChannelSyncSourceOptions,
): NusmSyncSource<TState>;

Prop

Type

key must be a non-extractable HMAC-SHA-256 CryptoKey with sign and verify usage, or at least 32 random bytes for runtime import. namespace and every store storeId contribute to an opaque channel capability. The optional limits can only reduce the built-in protocol maxima.

Prop

Type

Global and store options

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Prop

Type

Every configured source requires a validator. Validators reject malformed or unsafe candidates before memory or adapter state changes. See Authenticated synchronization for lifecycle, readiness, leader election, acknowledgements, limits, quarantine, and disposal behavior.

On this page