Skip to main content

Interface: OpenerConnection<In, Out, R>

Type Parameters

Type Parameter
In extends MessageMap
Out extends MessageMap
R

Properties

ready

readonly ready: Promise<void>;

Resolves once the opener acknowledges the ready handshake.

Methods

close()

close(): void;

Tell the opener we're going away, then close this window.

Returns

void


finish()

finish(result): void;

Deliver the terminal result to the opener. Does not close the window.

Parameters

ParameterType
resultR

Returns

void


on()

on<K>(type, handler): () => void;

Type Parameters

Type Parameter
K extends string

Parameters

ParameterType
typeK
handler(payload) => void

Returns

() => void


post()

post<K>(type, payload): void;

Queued until the handshake completes.

Type Parameters

Type Parameter
K extends string

Parameters

ParameterType
typeK
payloadOut[K]

Returns

void