Graphorin API reference v0.1.0

---

Graphorin API reference / @graphorin/core / / withSignal

Function: withSignal()

function withSignal<T>(source, signal?): AsyncIterable<T>;

Defined in: packages/core/src/utils/streams.ts:191

Wrap source with abort-signal propagation: when signal aborts the underlying iterator's return() is called and the loop exits cleanly.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
source	AsyncIterable<T>
signal?	AbortSignal

Returns

AsyncIterable<T>

Stable