ReactNamespace

The React half of a namespace: the same hooks, with every bus name prefixed.

Options keep their meaning — store and name are still relative names, and scope still says how far a value travels, which is a different axis from which namespace it lives in.

Extends

• Namespace

Properties

name

readonly name: string;

The prefix every name from this namespace carries.

Inherited from

Namespace.name

Methods

busName()

busName(name?): string;

What a bare name becomes here. Exposed so devtools, observeBus and tests can name the same bus.

Parameters

Parameter	Type
name?	string

Returns

string

Inherited from

Namespace.busName

---

createChannel()

createChannel<M>(name?, options?): Channel<M>;

Type Parameters

Type Parameter
M extends MessageMap

Parameters

Parameter	Type
name?	string
options?	ChannelOptions<M>

Returns

Channel<M>

Inherited from

Namespace.createChannel

---

createLeader()

createLeader(name?, options?): Leader;

Parameters

Parameter	Type
name?	string
options?	LeaderOptions

Returns

Leader

Inherited from

Namespace.createLeader

---

createPresence()

createPresence(name?, options?): Presence;

Parameters

Parameter	Type
name?	string
options?	PresenceOptions

Returns

Presence

Inherited from

Namespace.createPresence

---

createSharedStore()

createSharedStore<S>(
   name,
   initial,
options?): SharedStore<S>;

Type Parameters

Type Parameter
S extends Record<string, unknown>

Parameters

Parameter	Type
name	string | undefined
initial	S
options?	SharedStoreOptions<S>

Returns

SharedStore<S>

Inherited from

Namespace.createSharedStore

---

defineChannel()

defineChannel<M>(name?, options?): ChannelHooks<M>;

Type Parameters

Type Parameter
M extends MessageMap

Parameters

Parameter	Type
name?	string
options?	ChannelOptions<M>

Returns

ChannelHooks<M>

---

defineStore()

defineStore<S>(name, options?): StoreHooks<S>;

Type Parameters

Type Parameter	Default type
S extends Record<string, unknown>	Record<string, unknown>

Parameters

Parameter	Type
name	string
options?	DefineStoreOptions

Returns

StoreHooks<S>

---

getSharedStore()

getSharedStore(name?, scope?): AnyStore;

Parameters

Parameter	Type
name?	string
scope?	ShareScope

Returns

AnyStore

---

useClientId()

useClientId(options?): string;

Parameters

Parameter	Type
options?	{ name?: string; }
options.name?	string

Returns

string

---

useHydrated()

useHydrated(options?): boolean;

Parameters

Parameter	Type
options?	UseSharedStateOptions

Returns

boolean

---

useIsLeader()

useIsLeader(options?): boolean;

Parameters

Parameter	Type
options?	UseLeaderOptions

Returns

boolean

---

useLeader()

useLeader(options?): LeaderSnapshot;

Parameters

Parameter	Type
options?	UseLeaderOptions

Returns

LeaderSnapshot

---

useLeaderEffect()

useLeaderEffect(effect, options?): void;

Parameters

Parameter	Type
effect	() => void | (() => void)
options?	UseLeaderOptions

Returns

void

---

usePeers()

usePeers(options?): readonly Peer[];

Parameters

Parameter	Type
options?	UsePeersOptions

Returns

readonly Peer[]

---

usePresenceMetadata()

usePresenceMetadata(metadata, options?): void;

Parameters

Parameter	Type
metadata	unknown
options?	UsePeersOptions

Returns

void

---

useSharedState()

useSharedState<T>(
   key,
   initial,
   options?): [T, (next) => void];

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
key	string
initial	T
options?	UseSharedStateOptions

Returns

[T, (next) => void]

---

useSharedStore()

useSharedStore<S, T>(selector, options?): T;

Type Parameters

Type Parameter
S extends Record<string, unknown>
T

Parameters

Parameter	Type
selector	(state) => T
options?	UseSharedSelectorOptions

Returns

T