Documentation / @super-line/server / ConnTarget

Interface: ConnTarget<C>

Defined in: index.ts:251

A single targeted connection, reachable on whatever node holds it.

Type Parameters

C

C extends Contract

Methods

close()

close(): void

Defined in: index.ts:265

Close this connection (cross-node kick).

Returns

void

---

emit()

emit<E>(event, data): void

Defined in: index.ts:253

Push a shared event to this connection (cross-node).

Type Parameters

E

E extends string | number | symbol

Parameters

event

E

data

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

Returns

void

---

request()

request<M>(name, input, opts?): Promise<Output<ServerReqOf<StcOf<C["shared"]>>[M]>>

Defined in: index.ts:259

Send a shared server→client request and await the client's typed reply (cross-node). Rejects with a TIMEOUT SuperLineError if no live node owns the connection or the client doesn't answer in time.

Type Parameters

M

M extends string | number | symbol

Parameters

name

M

input

ClientInput<ServerReqOf<StcOf<C["shared"]>>[M]>

opts?

signal?

AbortSignal

timeout?

number

Returns

Promise<Output<ServerReqOf<StcOf<C["shared"]>>[M]>>

---

setEnv()

setEnv(env): void

Defined in: index.ts:267

Vend/update this connection's client-visible env (ADR-0012), cross-node. Validated per-conn on arrival.

Parameters

env

AnyEnv<C>

Returns

void