class FromResource<T,R>

An AsyncStream implementation that manages an external resource while streaming values. The resource is opened on first iteration and closed when the stream completes or is disposed.

Extends: AsyncStreamBase<T>

Type parameters

Name	Description
T	undocumented
R	undocumented

Properties

close

undocumented

Definition

readonly close?: ((resource: R) => MaybePromise<void>) | undefined;

createSource

undocumented

Definition

readonly createSource: (resource: R) => MaybePromise<AsyncStreamSource<T>>;

open

undocumented

Definition

readonly open: () => MaybePromise<R>;

Methods

[Symbol.asyncIterator]

undocumented

Definition

[Symbol.asyncIterator](): AsyncFastIterator<T>;

Overrides

AsyncStreamBase.[Symbol.asyncIterator]

append

undocumented

Definition

append(value: AsyncOptLazy<T>): AsyncStream.NonEmpty<T>;

Parameters

Name	Type	Description
value	AsyncOptLazy<T>

Overrides

AsyncStreamBase.append

asNormal

undocumented

Definition

asNormal(): AsyncStream<T>;

Overrides

AsyncStreamBase.asNormal

assumeNonEmpty

undocumented

Definition

assumeNonEmpty(): AsyncStream.NonEmpty<T>;

Overrides

AsyncStreamBase.assumeNonEmpty

asyncStream

undocumented

Definition

asyncStream(): this;

Overrides

AsyncStreamBase.asyncStream

collect

undocumented

Definition

collect<R>(collectFun: AsyncCollectFun<T, R>): AsyncStream<R>;

Type parameters

Name	Description
R

Parameters

Name	Type	Description
collectFun	AsyncCollectFun<T, R>

Overrides

AsyncStreamBase.collect

concat

undocumented

Definition

concat(...others: ArrayNonEmpty<AsyncStreamSource<T>>): any;

Parameters

Name	Type	Description
others	ArrayNonEmpty<AsyncStreamSource<T>>

Overrides

AsyncStreamBase.concat

contains

undocumented

Definition

contains(searchValue: T, options?: {
    amount?: number;
    eq?: Eq<T>;
    negate?: boolean;
  }): Promise<boolean>;

Parameters

Name	Type	Description
searchValue	T
options	{     amount?: number;     eq?: Eq<T>;     negate?: boolean;   }

Overrides

AsyncStreamBase.contains

containsSlice

undocumented

Definition

containsSlice(source: AsyncStreamSource.NonEmpty<T>, options?: {
    eq?: Eq<T>;
    amount?: number;
  }): Promise<boolean>;

Parameters

Name	Type	Description
source	AsyncStreamSource.NonEmpty<T>
options	{     eq?: Eq<T>;     amount?: number;   }

Overrides

AsyncStreamBase.containsSlice

count

undocumented

Definition

count(): Promise<number>;

Overrides

AsyncStreamBase.count

countElement

undocumented

Definition

countElement(value: T, options?: {
    eq?: Eq<T>;
    negate?: boolean;
  }): Promise<number>;

Parameters

Name	Type	Description
value	T
options	{     eq?: Eq<T>;     negate?: boolean;   }

Overrides

AsyncStreamBase.countElement

distinctPrevious

undocumented

Definition

distinctPrevious(options?: {
    eq?: Eq<T> | undefined;
    negate?: boolean | undefined;
  }): AsyncStream<T>;

Parameters

Name	Type	Description
options	{     eq?: Eq<T> | undefined;     negate?: boolean | undefined;   }

Overrides

AsyncStreamBase.distinctPrevious

drop

undocumented

Definition

drop(amount: number): AsyncStream<T>;

Parameters

Name	Type	Description
amount	number

Overrides

AsyncStreamBase.drop

dropWhile

undocumented

Definition

dropWhile(pred: (value: T, index: number) => MaybePromise<boolean>, options?: {
    negate?: boolean;
  }): AsyncStream<T>;

Parameters

Name	Type	Description
pred	(value: T, index: number) => MaybePromise<boolean>
options	{     negate?: boolean;   }

Overrides

AsyncStreamBase.dropWhile

elementAt

undocumented

Definition

elementAt<O>(index: number, otherwise?: AsyncOptLazy<O>): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
index	number
otherwise	AsyncOptLazy<O>

Overrides

AsyncStreamBase.elementAt

equals

undocumented

Definition

equals(other: AsyncStreamSource<T>, options?: {
    eq?: Eq<T>;
    negate?: boolean;
  }): Promise<boolean>;

Parameters

Name	Type	Description
other	AsyncStreamSource<T>
options	{     eq?: Eq<T>;     negate?: boolean;   }

Overrides

AsyncStreamBase.equals

every

undocumented

Definition

every(pred: (value: T, index: number) => MaybePromise<boolean>, options?: {
    negate?: boolean;
  }): Promise<boolean>;

Parameters

Name	Type	Description
pred	(value: T, index: number) => MaybePromise<boolean>
options	{     negate?: boolean;   }

Overrides

AsyncStreamBase.every

filter

undocumented

Definition

filter(pred: (value: T, index: number, halt: () => void) => MaybePromise<boolean>, options?: {
    negate?: boolean | undefined;
  }): any;

Parameters

Name	Type	Description
pred	(value: T, index: number, halt: () => void) => MaybePromise<boolean>
options	{     negate?: boolean | undefined;   }

Overrides

AsyncStreamBase.filter

filterPure

undocumented

Definition

filterPure<A extends readonly unknown[]>(options: {
    pred: (value: T, ...args: A) => MaybePromise<boolean>;
    negate?: boolean | undefined;
  }, ...args: A): any;

Type parameters

Name	Constraints	Description
A	readonly unknown[]

Parameters

Name	Type	Description
options	{     pred: (value: T, ...args: A) => MaybePromise<boolean>;     negate?: boolean | undefined;   }
args	A

Overrides

AsyncStreamBase.filterPure

find

undocumented

Definition

find<O>(pred: (value: T, index: number) => MaybePromise<boolean>, options?: {
    occurrance?: number | undefined;
    negate?: boolean | undefined;
    otherwise?: AsyncOptLazy<O>;
  }): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
pred	(value: T, index: number) => MaybePromise<boolean>
options	{     occurrance?: number | undefined;     negate?: boolean | undefined;     otherwise?: AsyncOptLazy<O>;   }

Overrides

AsyncStreamBase.find

first

undocumented

Definition

first<O>(otherwise?: AsyncOptLazy<O>): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
otherwise	AsyncOptLazy<O>

Overrides

AsyncStreamBase.first

flatMap

undocumented

Definition

flatMap<T2>(flatMapFun: (value: T, index: number, halt: () => void) => AsyncStreamSource<T2>): AsyncStream<T2>;

Type parameters

Name	Description
T2

Parameters

Name	Type	Description
flatMapFun	(value: T, index: number, halt: () => void) => AsyncStreamSource<T2>

Overrides

AsyncStreamBase.flatMap

flatZip

undocumented

Definition

flatZip<T2>(flatMapFun: (value: T, index: number, halt: () => void) => AsyncStreamSource<T2>): AsyncStream<[T, T2]>;

Type parameters

Name	Description
T2

Parameters

Name	Type	Description
flatMapFun	(value: T, index: number, halt: () => void) => AsyncStreamSource<T2>

Overrides

AsyncStreamBase.flatZip

fold

undocumented

Definition

fold<R>(init: AsyncOptLazy<R>, next: (current: R, value: T, index: number, halt: () => void) => MaybePromise<R>): Promise<R>;

Type parameters

Name	Description
R

Parameters

Name	Type	Description
init	AsyncOptLazy<R>
next	(current: R, value: T, index: number, halt: () => void) => MaybePromise<R>

Overrides

AsyncStreamBase.fold

foldStream

undocumented

Definition

foldStream<R>(init: AsyncOptLazy<R>, next: (current: R, value: T, index: number, halt: () => void) => MaybePromise<R>): AsyncStream<R>;

Type parameters

Name	Description
R

Parameters

Name	Type	Description
init	AsyncOptLazy<R>
next	(current: R, value: T, index: number, halt: () => void) => MaybePromise<R>

Overrides

AsyncStreamBase.foldStream

forEach

undocumented

Definition

forEach(f: (value: T, index: number, halt: () => void) => MaybePromise<void>, options?: {
    state?: TraverseState;
  }): Promise<void>;

Parameters

Name	Type	Description
f	(value: T, index: number, halt: () => void) => MaybePromise<void>
options	{     state?: TraverseState;   }

Overrides

AsyncStreamBase.forEach

forEachPure

undocumented

Definition

forEachPure<A extends readonly unknown[]>(f: (value: T, ...args: A) => MaybePromise<void>, ...args: A): Promise<void>;

Type parameters

Name	Constraints	Description
A	readonly unknown[]

Parameters

Name	Type	Description
f	(value: T, ...args: A) => MaybePromise<void>
args	A

Overrides

AsyncStreamBase.forEachPure

groupBy

undocumented

Definition

groupBy<K, R>(valueToKey: (value: T, index: number) => MaybePromise<K>, options?: {
    collector?: AsyncReducer.Accept<readonly [K, T], R> | undefined;
  }): Promise<R>;

Type parameters

Name	Description
K
R

Parameters

Name	Type	Description
valueToKey	(value: T, index: number) => MaybePromise<K>
options	{     collector?: AsyncReducer.Accept<readonly [K, T], R> | undefined;   }

Overrides

AsyncStreamBase.groupBy

indexed

undocumented

Definition

indexed(options?: {
    startIndex?: number;
  }): AsyncStream<[number, T]>;

Parameters

Name	Type	Description
options	{     startIndex?: number;   }

Overrides

AsyncStreamBase.indexed

indexOf

undocumented

Definition

indexOf(searchValue: T, options?: {
    occurrance?: number | undefined;
    eq?: Eq<T> | undefined;
    negate?: boolean | undefined;
  }): Promise<number | undefined>;

Parameters

Name	Type	Description
searchValue	T
options	{     occurrance?: number | undefined;     eq?: Eq<T> | undefined;     negate?: boolean | undefined;   }

Overrides

AsyncStreamBase.indexOf

indexWhere

undocumented

Definition

indexWhere(pred: (value: T, index: number) => MaybePromise<boolean>, options?: {
    occurrance?: number;
    negate?: boolean;
  }): Promise<number | undefined>;

Parameters

Name	Type	Description
pred	(value: T, index: number) => MaybePromise<boolean>
options	{     occurrance?: number;     negate?: boolean;   }

Overrides

AsyncStreamBase.indexWhere

indicesOf

undocumented

Definition

indicesOf(searchValue: T, options?: {
    eq?: Eq<T>;
    negate?: boolean;
  }): AsyncStream<number>;

Parameters

Name	Type	Description
searchValue	T
options	{     eq?: Eq<T>;     negate?: boolean;   }

Overrides

AsyncStreamBase.indicesOf

indicesWhere

undocumented

Definition

indicesWhere(pred: (value: T) => MaybePromise<boolean>, options?: {
    negate?: boolean;
  }): AsyncStream<number>;

Parameters

Name	Type	Description
pred	(value: T) => MaybePromise<boolean>
options	{     negate?: boolean;   }

Overrides

AsyncStreamBase.indicesWhere

intersperse

undocumented

Definition

intersperse(sep: AsyncStreamSource<T>): AsyncStream<T>;

Parameters

Name	Type	Description
sep	AsyncStreamSource<T>

Overrides

AsyncStreamBase.intersperse

join

undocumented

Definition

join({ sep, start, end, valueToString, ifEmpty, }?: {
    sep?: string | undefined;
    start?: string | undefined;
    end?: string | undefined;
    valueToString?: StringConstructor | undefined;
    ifEmpty?: undefined;
  }): Promise<string>;

Parameters

Name	Type	Description
{ sep, start, end, valueToString, ifEmpty, }	{     sep?: string | undefined;     start?: string | undefined;     end?: string | undefined;     valueToString?: StringConstructor | undefined;     ifEmpty?: undefined;   }

Overrides

AsyncStreamBase.join

last

undocumented

Definition

last<O>(otherwise?: AsyncOptLazy<O>): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
otherwise	AsyncOptLazy<O>

Overrides

AsyncStreamBase.last

map

undocumented

Definition

map<T2>(mapFun: (value: T, index: number) => MaybePromise<T2>): AsyncStream<T2>;

Type parameters

Name	Description
T2

Parameters

Name	Type	Description
mapFun	(value: T, index: number) => MaybePromise<T2>

Overrides

AsyncStreamBase.map

mapPure

undocumented

Definition

mapPure<T2, A extends readonly unknown[]>(mapFun: (value: T, ...args: A) => MaybePromise<T2>, ...args: A): AsyncStream<T2>;

Type parameters

Name	Constraints	Description
T2
A	readonly unknown[]

Parameters

Name	Type	Description
mapFun	(value: T, ...args: A) => MaybePromise<T2>
args	A

Overrides

AsyncStreamBase.mapPure

max

undocumented

Definition

max<O>(otherwise?: AsyncOptLazy<O>): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
otherwise	AsyncOptLazy<O>

Overrides

AsyncStreamBase.max

maxBy

undocumented

Definition

maxBy<O>(compare: (v1: T, v2: T) => number, otherwise?: AsyncOptLazy<O>): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
compare	(v1: T, v2: T) => number
otherwise	AsyncOptLazy<O>

Overrides

AsyncStreamBase.maxBy

min

undocumented

Definition

min<O>(otherwise?: AsyncOptLazy<O>): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
otherwise	AsyncOptLazy<O>

Overrides

AsyncStreamBase.min

minBy

undocumented

Definition

minBy<O>(compare: (v1: T, v2: T) => number, otherwise?: AsyncOptLazy<O>): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
compare	(v1: T, v2: T) => number
otherwise	AsyncOptLazy<O>

Overrides

AsyncStreamBase.minBy

mkGroup

undocumented

Definition

mkGroup({ sep, start, end, }?: {
    sep?: AsyncStreamSource<T>;
    start?: AsyncStreamSource<T>;
    end?: AsyncStreamSource<T>;
  }): any;

Parameters

Name	Type	Description
{ sep, start, end, }	{     sep?: AsyncStreamSource<T>;     start?: AsyncStreamSource<T>;     end?: AsyncStreamSource<T>;   }

Overrides

AsyncStreamBase.mkGroup

partition

undocumented

Definition

partition(pred: (value: T, index: number) => MaybePromise<boolean>, options?: {
    collectorTrue?: any;
    collectorFalse?: any;
  }): Promise<[any, any]>;

Parameters

Name	Type	Description
pred	(value: T, index: number) => MaybePromise<boolean>
options	{     collectorTrue?: any;     collectorFalse?: any;   }

Overrides

AsyncStreamBase.partition

prepend

undocumented

Definition

prepend(value: AsyncOptLazy<T>): AsyncStream.NonEmpty<T>;

Parameters

Name	Type	Description
value	AsyncOptLazy<T>

Overrides

AsyncStreamBase.prepend

reduce

undocumented

Definition

reduce<const S extends AsyncReducer.CombineShape<T>>(shape: S & AsyncReducer.CombineShape<T>): Promise<AsyncReducer.CombineResult<S>>;

Type parameters

Name	Constraints	Description
S	AsyncReducer.CombineShape<T>

Parameters

Name	Type	Description
shape	S & AsyncReducer.CombineShape<T>

Overrides

AsyncStreamBase.reduce

reduceStream

undocumented

Definition

reduceStream<const S extends AsyncReducer.CombineShape<T>>(shape: S & AsyncReducer.CombineShape<T>): AsyncStream<AsyncReducer.CombineResult<S>>;

Type parameters

Name	Constraints	Description
S	AsyncReducer.CombineShape<T>

Parameters

Name	Type	Description
shape	S & AsyncReducer.CombineShape<T>

Overrides

AsyncStreamBase.reduceStream

repeat

undocumented

Definition

repeat(amount?: number): AsyncStream<T>;

Parameters

Name	Type	Description
amount	number

Overrides

AsyncStreamBase.repeat

single

undocumented

Definition

single<O>(otherwise?: AsyncOptLazy<O>): Promise<T | O>;

Type parameters

Name	Description
O

Parameters

Name	Type	Description
otherwise	AsyncOptLazy<O>

Overrides

AsyncStreamBase.single

some

undocumented

Definition

some(pred: (value: T, index: number) => MaybePromise<boolean>, options?: {
    negate?: boolean;
  }): Promise<boolean>;

Parameters

Name	Type	Description
pred	(value: T, index: number) => MaybePromise<boolean>
options	{     negate?: boolean;   }

Overrides

AsyncStreamBase.some

splitOn

undocumented

Definition

splitOn<R>(sepElem: T, options?: {
    eq?: Eq<T> | undefined;
    negate?: boolean | undefined;
    collector?: AsyncReducer.Accept<T, R> | undefined;
  }): AsyncStream<R>;

Type parameters

Name	Description
R

Parameters

Name	Type	Description
sepElem	T
options	{     eq?: Eq<T> | undefined;     negate?: boolean | undefined;     collector?: AsyncReducer.Accept<T, R> | undefined;   }

Overrides

AsyncStreamBase.splitOn

splitOnSlice

undocumented

Definition

splitOnSlice<R>(sepSlice: AsyncStreamSource<T>, options?: {
    eq?: Eq<T> | undefined;
    collector?: AsyncReducer.Accept<T, R> | undefined;
  }): AsyncStream<R>;

Type parameters

Name	Description
R

Parameters

Name	Type	Description
sepSlice	AsyncStreamSource<T>
options	{     eq?: Eq<T> | undefined;     collector?: AsyncReducer.Accept<T, R> | undefined;   }

Overrides

AsyncStreamBase.splitOnSlice

splitWhere

undocumented

Definition

splitWhere<R>(pred: (value: T, index: number) => MaybePromise<boolean>, options?: {
    negate?: boolean | undefined;
    collector?: AsyncReducer.Accept<T, R> | undefined;
  }): AsyncStream<R>;

Type parameters

Name	Description
R

Parameters

Name	Type	Description
pred	(value: T, index: number) => MaybePromise<boolean>
options	{     negate?: boolean | undefined;     collector?: AsyncReducer.Accept<T, R> | undefined;   }

Overrides

AsyncStreamBase.splitWhere

take

undocumented

Definition

take(amount: number): AsyncStream<T>;

Parameters

Name	Type	Description
amount	number

Overrides

AsyncStreamBase.take

takeWhile

undocumented

Definition

takeWhile(pred: (value: T, index: number) => MaybePromise<boolean>, options?: {
    negate?: boolean;
  }): AsyncStream<T>;

Parameters

Name	Type	Description
pred	(value: T, index: number) => MaybePromise<boolean>
options	{     negate?: boolean;   }

Overrides

AsyncStreamBase.takeWhile

toArray

undocumented

Definition

toArray(): Promise<T[]>;

Overrides

AsyncStreamBase.toArray

toJSON

undocumented

Definition

toJSON(): Promise<ToJSON<T[], 'AsyncStream'>>;

Overrides

AsyncStreamBase.toJSON

toString

undocumented

Definition

toString(): string;

Overrides

AsyncStreamBase.toString

transform

undocumented

Definition

transform<R>(transformer: AsyncTransformer.Accept<T, R>): AsyncStream<R>;

Type parameters

Name	Description
R

Parameters

Name	Type	Description
transformer	AsyncTransformer.Accept<T, R>

Overrides

AsyncStreamBase.transform

window

undocumented

Definition

window<R>(windowSize: number, options?: {
    skipAmount?: number | undefined;
    collector?: AsyncReducer.Accept<T, R> | undefined;
  }): AsyncStream<R>;

Type parameters

Name	Description
R

Parameters

Name	Type	Description
windowSize	number
options	{     skipAmount?: number | undefined;     collector?: AsyncReducer.Accept<T, R> | undefined;   }

Overrides

AsyncStreamBase.window

withOnly

undocumented

Definition

withOnly<F extends T>(values: F[]): AsyncStream<F>;

Type parameters

Name	Constraints	Description
F	T

Parameters

Name	Type	Description
values	F[]

Overrides

AsyncStreamBase.withOnly

without

undocumented

Definition

without<F extends T>(values: F[]): any;

Type parameters

Name	Constraints	Description
F	T

Parameters

Name	Type	Description
values	F[]

Overrides

AsyncStreamBase.without