Documentation
Common
Interfaces
Sink

Interface: Sink<T>

Defined in: src/common.ts:65

A representation of any set of values over any amount of time.

Type Parameters

T = unknown

Methods

complete()

complete(): void

Defined in: src/common.ts:77

The sink has completed. This function “closes” the sink.

Returns

void


error()

error(error): void

Defined in: src/common.ts:75

An error that has occured. Calling this function “closes” the sink. Besides the errors being Error and readonly GraphQLError[], it can also be a CloseEvent, but to avoid bundling DOM typings because the client can run in Node env too, you should assert the close event type during implementation.

Parameters

error

unknown

Returns

void


next()

next(value): void

Defined in: src/common.ts:67

Next value arriving.

Parameters

value

T

Returns

void