Skip to content

Documentation / @super-line/client / EnvHandle

Interface: EnvHandle<E>

Defined in: index.ts:149

A reactive handle over a connection's client-visible SuperLineClient.env (ADR-0012).

Type Parameters

E

E

Properties

current

readonly current: E

Defined in: index.ts:151

The latest env pushed by the server (null until the first push / for a role with no env).


ready

readonly ready: Promise<void>

Defined in: index.ts:153

Resolves after the first env push — await before reading current. Kills the connect-time race.

Methods

subscribe()

subscribe(cb): () => void

Defined in: index.ts:155

Fire on every env update; returns an unsubscribe fn.

Parameters

cb

(env) => void

Returns

() => void

Released under the MIT License.