Interface IterableQueue<T>

An extended async iterable that can pull from a value pool. Iterable queues can be created via the queue function.

Type Parameters

  • T

    The type of the elements in the iterable queue.

Hierarchy

Properties

at buffer close concat consume every filter find first forEach fork getIterator isEmpty map pipe push reduce scan seal slice some take throttle toArray

Methods

[asyncIterator]

Properties

at

at: ((n: number) => Promise<undefined | T>)

Type declaration

    • (n: number): Promise<undefined | T>

    • Parameters

      • n: number

      Returns Promise<undefined | T>

buffer

buffer: ((ms: number) => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

close

close: (() => void)

Type declaration

    • (): void

    • Closes the queue, immediately marking the iterable as complete and stopping the consumption of items.

      Returns void

concat

concat: ((...iterables: (ExtendedAsyncIterable<T> | AsyncIterable<T> | Iterable<T> | ExtendedIterable<T>)[]) => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

consume

consume: (<U>(mapFn?: MapFn<T, U>) => Promise<U[]>)

Type declaration

    • <U>(mapFn?: MapFn<T, U>): Promise<U[]>

    • Type Parameters

      • U

      Parameters

      • Optional mapFn: MapFn<T, U>

      Returns Promise<U[]>

every

every: ((predicate: AsyncArrayLikePredicate<T>) => Promise<boolean>)

Type declaration

filter

filter: ((predicate: AsyncArrayLikePredicate<T>) => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

find

find: ((predicate: AsyncArrayLikePredicate<T>) => Promise<undefined | T>)

Type declaration

first

first: ((predicate?: AsyncArrayLikePredicate<T>) => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

forEach

forEach: ((fn: ((element: T, index: number) => MaybePromise<void>)) => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

fork

fork: ((n?: number) => IterableQueue<T>[])

Type declaration

    • (n?: number): IterableQueue<T>[]

    • Forks the queue into n sub-queues (default 2). Each sub-queue receives the same values as the original queue.

      Parameters

      • Optional n: number

      Returns IterableQueue<T>[]

getIterator

getIterator: (() => AsyncIterator<T, any, undefined>)

Type declaration

    • (): AsyncIterator<T, any, undefined>

    • Returns AsyncIterator<T, any, undefined>

isEmpty

isEmpty: (() => Promise<boolean>)

Type declaration

    • (): Promise<boolean>

    • Returns Promise<boolean>

map

map: (<U>(mapFn: MapFn<T, U>) => ExtendedAsyncIterable<Awaited<U>>)

Type declaration

pipe

pipe: CookedPipe<ExtendedAsyncIterable<T>>

push

push: ((value: T) => void)

Type declaration

    • (value: T): void

    • Pushes a new value onto the queue, making it available for consumption.

      Parameters

      • value: T

      Returns void

reduce

reduce: (<U>(reducer: AsyncReducer<T, U>, initialValue?: U) => Promise<U>)

Type declaration

    • <U>(reducer: AsyncReducer<T, U>, initialValue?: U): Promise<U>

    • Type Parameters

      • U = T

      Parameters

      Returns Promise<U>

scan

scan: (<U>(reducer: AsyncReducer<T, U>, initialValue?: U) => ExtendedAsyncIterable<Awaited<U>>)

Type declaration

seal

seal: (() => void)

Type declaration

    • (): void

    • Seals the queue, preventing new values from being pushed. The queue is marked as complete once the value pool is empty.

      Returns void

slice

slice: ((startIndex: number, endIndex?: number) => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

some

some: ((predicate: AsyncArrayLikePredicate<T>) => Promise<boolean>)

Type declaration

take

take: ((n: number) => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

throttle

throttle: ((ms: number) => ExtendedAsyncIterable<Awaited<T>>)

Type declaration

toArray

toArray: (() => Promise<T[]>)

Type declaration

    • (): Promise<T[]>

    • Returns Promise<T[]>

Methods

[asyncIterator]

  • [asyncIterator](): AsyncIterator<T, any, undefined>

  • Returns AsyncIterator<T, any, undefined>

Settings

Member Visibility

Theme

Generated using TypeDoc