Lelantos SDK

Appearance

@lelantos-org/sdk / services/relayer / EventSourceLike

Interface: EventSourceLike ​

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:37

The slice of EventSource this client uses.

Structural, so a browser EventSource, a Node polyfill, or a test double all satisfy it without a cast. readyState is required because it is the only way to tell a transient drop the source will retry from a fatal error it will not.

Properties ​

readyState ​

ts
readonly readyState: number;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:38

Methods ​

addEventListener() ​

ts
addEventListener(type, listener): void;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:39

Parameters ​

ParameterType
typestring
listener(ev) => void

Returns ​

void

close() ​

ts
close(): void;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:50

Returns ​

void

removeEventListener()? ​

ts
optional removeEventListener(type, listener): void;

Defined in: @lelantos-org/sdk/dist/services/relayer/deposit-stream.d.ts:47

Optional so a minimal custom source stays valid, but implement it where possible: without it a closed stream's handlers stay attached to the source for as long as the source itself is reachable.

Parameters ​

ParameterType
typestring
listener(ev) => void

Returns ​

void