Documentation / @super-line/server / UserTarget

Interface: UserTarget<C>

Defined in: index.ts:266

All of a user's connections (0..N devices), reachable across nodes.

Type Parameters

C

C extends Contract

Methods

disconnect()

disconnect(): void

Defined in: index.ts:270

Disconnect every one of the user's connections (cross-node).

Returns

void

---

emit()

emit<E>(event, data): void

Defined in: index.ts:268

Push a shared event to every one of the user's connections (cross-node).

Type Parameters

E

E extends string | number | symbol

Parameters

event

E

data

EmitData<EventsOf<StcOf<C["shared"]>>[E]>

Returns

void

---

setEnv()

setEnv(env): void

Defined in: index.ts:272

Vend/update env (ADR-0012) on every one of the user's connections, cross-node. Validated per-conn on arrival.

Parameters

env

AnyEnv<C>

Returns

void