Module flu

Functions

flu

flu<T>(iter: AsyncIterable<T>): Flu<T>

- Defined in flu.ts:5
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Flu<T>

fromIter

fromIter<T>(iter: Iterable<T | Promise<T>>): AsyncIterable<T>

- Defined in flu.ts:419
Type parameters
- T
Parameters
- iter: Iterable<T | Promise<T>>
Returns AsyncIterable<T>

of

of<T>(...iter: T[]): AsyncIterable<T>

- Defined in flu.ts:425
Type parameters
- T
Parameters
- Rest ...iter: T[]
Returns AsyncIterable<T>

from

from<T>(iter: Iterable<T>): AsyncIterable<T>

- Defined in flu.ts:431
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns AsyncIterable<T>

collect

collect<T>(iter: AsyncIterable<T>): Promise<T[]>

- Defined in flu.ts:437
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Promise<T[]>

join

join<T>(iter: AsyncIterable<T>, separator?: string): Promise<string>

- Defined in flu.ts:445
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- Optional separator: string
Returns Promise<string>

count

count<T>(iter: AsyncIterable<T>): Promise<number>

- Defined in flu.ts:449
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Promise<number>

isEmpty

isEmpty<T>(iter: AsyncIterable<T>): Promise<boolean>

- Defined in flu.ts:453
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Promise<boolean>

first

first<T>(iter: AsyncIterable<T>): Promise<Voidable<T>>

- Defined in flu.ts:458
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Promise<Voidable<T>>

firstO

firstO<T>(iter: AsyncIterable<T>): Promise<Option<T>>

- Defined in flu.ts:462
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Promise<Option<T>>

last

last<T>(iter: AsyncIterable<T>): Promise<Voidable<T>>

- Defined in flu.ts:467
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Promise<Voidable<T>>

lastO

lastO<T>(iter: AsyncIterable<T>): Promise<Option<T>>

- Defined in flu.ts:475
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Promise<Option<T>>

nth

nth<T>(iter: AsyncIterable<T>, n: number): Promise<Voidable<T>>

- Defined in flu.ts:484
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- n: number
Returns Promise<Voidable<T>>

nthO

nthO<T>(iter: AsyncIterable<T>, n: number): Promise<Option<T>>

- Defined in flu.ts:494
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- n: number
Returns Promise<Option<T>>

stepBy

stepBy<T>(iter: AsyncIterable<T>, step: number): AsyncIterable<T>

- Defined in flu.ts:504
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- step: number
Returns AsyncIterable<T>

chain

chain<T>(a: AsyncIterable<T> | Iterable<T>, b: AsyncIterable<T> | Iterable<T>, ...more: (AsyncIterable<T> | Iterable<T>)[]): AsyncIterable<T>

- Defined in flu.ts:518
Type parameters
- T
Parameters
- a: AsyncIterable<T> | Iterable<T>
- b: AsyncIterable<T> | Iterable<T>
- Rest ...more: (AsyncIterable<T> | Iterable<T>)[]
Returns AsyncIterable<T>

zip

zip<A, B>(a: AsyncIterable<A>, b: AsyncIterable<B>): AsyncIterable<[A, B]>

- Defined in flu.ts:526
Type parameters
- A
- B
Parameters
- a: AsyncIterable<A>
- b: AsyncIterable<B>
Returns AsyncIterable<[A, B]>

unzip

unzip<A, B>(iter: AsyncIterable<[A, B]>): Promise<[A[], B[]]>

- Defined in flu.ts:538
Type parameters
- A
- B
Parameters
- iter: AsyncIterable<[A, B]>
Returns Promise<[A[], B[]]>

map

map<T, R>(iter: AsyncIterable<T>, f: (v: T) => R): AsyncIterable<R>

- Defined in flu.ts:547
Type parameters
- T
- R
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => R
  - - (v: T): R
    - Parameters
      - v: T
      Returns R
Returns AsyncIterable<R>

mapWait

mapWait<T, R>(iter: AsyncIterable<T>, f: (v: T) => R | PromiseLike<R>): AsyncIterable<R>

- Defined in flu.ts:553
Type parameters
- T
- R
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => R | PromiseLike<R>
  - - (v: T): R | PromiseLike<R>
    - Parameters
      - v: T
      Returns R | PromiseLike<R>
Returns AsyncIterable<R>

fill

fill<T, R>(iter: AsyncIterable<T>, v: R): AsyncIterable<R>

- Defined in flu.ts:559
Type parameters
- T
- R
Parameters
- iter: AsyncIterable<T>
- v: R
Returns AsyncIterable<R>

forEach

forEach<T>(iter: AsyncIterable<T>, f: (v: T) => unknown): Promise<void>

- Defined in flu.ts:565
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns Promise<void>

run

run<T>(iter: AsyncIterable<T>): Promise<void>

- Defined in flu.ts:571
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns Promise<void>

filter

filter<T, S>(iter: AsyncIterable<T>, f: (v: T) => v is S): AsyncIterable<S>
filter<T>(iter: AsyncIterable<T>, f: (v: T) => unknown): AsyncIterable<T>

- Defined in flu.ts:575
Type parameters
- T
- S
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => v is S
  - - (v: T): v is S
    - Parameters
      - v: T
      Returns v is S
Returns AsyncIterable<S>
- Defined in flu.ts:576
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns AsyncIterable<T>

enumerate

enumerate<T>(iter: AsyncIterable<T>): AsyncIterable<[T, number]>

- Defined in flu.ts:583
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns AsyncIterable<[T, number]>

indexed

indexed<T>(iter: AsyncIterable<T>): AsyncIterable<[number, T]>

- Defined in flu.ts:591
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns AsyncIterable<[number, T]>

skip

skip<T>(iter: AsyncIterable<T>, n: number): AsyncIterable<T>

- Defined in flu.ts:599
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- n: number
Returns AsyncIterable<T>

take

take<T>(iter: AsyncIterable<T>, n: number): AsyncIterable<T>

- Defined in flu.ts:605
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- n: number
Returns AsyncIterable<T>

slice

slice<T>(iter: AsyncIterable<T>, from: number, to: number): AsyncIterable<T>

- Defined in flu.ts:612
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- from: number
- to: number
Returns AsyncIterable<T>

sub

sub<T>(iter: AsyncIterable<T>, from: number, count: number): AsyncIterable<T>

- Defined in flu.ts:619
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- from: number
- count: number
Returns AsyncIterable<T>

scan

scan<T, R>(iter: AsyncIterable<T>, init: R, f: (acc: R, val: T) => R): AsyncIterable<R>

- Defined in flu.ts:623
Type parameters
- T
- R
Parameters
- iter: AsyncIterable<T>
- init: R
- f: (acc: R, val: T) => R
  - - (acc: R, val: T): R
    - Parameters
      - acc: R
      - val: T
      Returns R
Returns AsyncIterable<R>

scanWait

scanWait<T, R>(iter: AsyncIterable<T>, init: R | PromiseLike<R>, f: (acc: R, val: T) => R | PromiseLike<R>): AsyncIterable<R>

- Defined in flu.ts:631
Type parameters
- T
- R
Parameters
- iter: AsyncIterable<T>
- init: R | PromiseLike<R>
- f: (acc: R, val: T) => R | PromiseLike<R>
  - - (acc: R, val: T): R | PromiseLike<R>
    - Parameters
      - acc: R
      - val: T
      Returns R | PromiseLike<R>
Returns AsyncIterable<R>

flatMap

flatMap<T, R>(iter: AsyncIterable<T>, f: (v: T) => AsyncIterable<R> | Iterable<R>): AsyncIterable<R>

- Defined in flu.ts:639
Type parameters
- T
- R
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => AsyncIterable<R> | Iterable<R>
  - - (v: T): AsyncIterable<R> | Iterable<R>
    - Parameters
      - v: T
      Returns AsyncIterable<R> | Iterable<R>
Returns AsyncIterable<R>

flatten

flatten<T>(iter: AsyncIterable<AsyncIterable<T> | Iterable<T>>): AsyncIterable<T>

- Defined in flu.ts:645
Type parameters
- T
Parameters
- iter: AsyncIterable<AsyncIterable<T> | Iterable<T>>
Returns AsyncIterable<T>

wait

wait<T>(iter: AsyncIterable<T | PromiseLike<T>>): AsyncIterable<T>

- Defined in flu.ts:651
Type parameters
- T
Parameters
- iter: AsyncIterable<T | PromiseLike<T>>
Returns AsyncIterable<T>

also

also<T>(iter: AsyncIterable<T>, f: (v: T) => unknown): AsyncIterable<T>

- Defined in flu.ts:657
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns AsyncIterable<T>

fold

fold<T, R>(a: AsyncIterable<T>, init: R, f: (acc: R, val: T) => R): Promise<R>

- Defined in flu.ts:664
Type parameters
- T
- R
Parameters
- a: AsyncIterable<T>
- init: R
- f: (acc: R, val: T) => R
  - - (acc: R, val: T): R
    - Parameters
      - acc: R
      - val: T
      Returns R
Returns Promise<R>

foldWait

foldWait<T, R>(a: AsyncIterable<T>, init: R | PromiseLike<R>, f: (acc: R, val: T) => R | PromiseLike<R>): Promise<R>

- Defined in flu.ts:672
Type parameters
- T
- R
Parameters
- a: AsyncIterable<T>
- init: R | PromiseLike<R>
- f: (acc: R, val: T) => R | PromiseLike<R>
  - - (acc: R, val: T): R | PromiseLike<R>
    - Parameters
      - acc: R
      - val: T
      Returns R | PromiseLike<R>
Returns Promise<R>

reduce

reduce<T>(a: AsyncIterable<T>, f: (acc: T, val: T) => T): Promise<T>

- Defined in flu.ts:680
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- f: (acc: T, val: T) => T
  - - (acc: T, val: T): T
    - Parameters
      - acc: T
      - val: T
      Returns T
Returns Promise<T>

reduceWait

reduceWait<T>(a: AsyncIterable<T>, f: (acc: T, val: T) => T | PromiseLike<T>): Promise<T>

- Defined in flu.ts:690
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- f: (acc: T, val: T) => T | PromiseLike<T>
  - - (acc: T, val: T): T | PromiseLike<T>
    - Parameters
      - acc: T
      - val: T
      Returns T | PromiseLike<T>
Returns Promise<T>

all

all<T>(a: AsyncIterable<T>, f: (v: T) => unknown): Promise<boolean>

- Defined in flu.ts:700
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns Promise<boolean>

any

any<T>(a: AsyncIterable<T>, f: (v: T) => unknown): Promise<boolean>

- Defined in flu.ts:707
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns Promise<boolean>

find

find<T>(a: AsyncIterable<T>, f: (v: T) => unknown): Promise<Voidable<T>>

- Defined in flu.ts:714
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns Promise<Voidable<T>>

position

position<T>(a: AsyncIterable<T>, f: (v: T) => unknown): Promise<number>

- Defined in flu.ts:720
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns Promise<number>

indexOf

indexOf<T>(a: AsyncIterable<T>, v: T): Promise<number>

- Defined in flu.ts:727
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- v: T
Returns Promise<number>

indexOfWait

indexOfWait<T>(a: AsyncIterable<T>, v: T | PromiseLike<T>): Promise<number>

- Defined in flu.ts:734
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- v: T | PromiseLike<T>
Returns Promise<number>

max

max<T>(a: AsyncIterable<T>): Promise<Voidable<T>>

- Defined in flu.ts:742
Type parameters
- T
Parameters
- a: AsyncIterable<T>
Returns Promise<Voidable<T>>

min

min<T>(a: AsyncIterable<T>): Promise<Voidable<T>>

- Defined in flu.ts:751
Type parameters
- T
Parameters
- a: AsyncIterable<T>
Returns Promise<Voidable<T>>

merge

merge<A, B>(a: AsyncIterable<A>, b: AsyncIterable<B>): AsyncIterable<A | B>

- Defined in flu.ts:769
Type parameters
- A
- B
Parameters
- a: AsyncIterable<A>
- b: AsyncIterable<B>
Returns AsyncIterable<A | B>

delay

delay<T>(iter: AsyncIterable<T>, ms?: Voidable<number>, f?: (v: T) => unknown): AsyncIterable<T>

- Defined in flu.ts:788
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- Optional ms: Voidable<number>
- Optional f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns AsyncIterable<T>

retry

retry<T, E>(iterFn: () => AsyncIterable<T>, count?: number | ((err: E, count: number) => unknown)): AsyncIterable<T>

- Defined in flu.ts:802
Type parameters
- T
- E = unknown
Parameters
- iterFn: () => AsyncIterable<T>
  - - (): AsyncIterable<T>
    - Returns AsyncIterable<T>
- count: number | ((err: E, count: number) => unknown) = Infinity
Returns AsyncIterable<T>

timestamp

timestamp<T>(iter: AsyncIterable<T>): AsyncIterable<[value: T, timestamp: number]>

- Defined in flu.ts:835
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns AsyncIterable<[value: T, timestamp: number]>

throttle

throttle<T>(iter: AsyncIterable<T>, ms?: number): AsyncIterable<T>

- Defined in flu.ts:841
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- ms: number = 300
Returns AsyncIterable<T>

debounce

debounce<T>(iter: AsyncIterable<T>, ms?: number): AsyncIterable<T>

- Defined in flu.ts:852
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- ms: number = 300
Returns AsyncIterable<T>

audit

audit<T>(iter: AsyncIterable<T>, ms?: number): AsyncIterable<T>

- Defined in flu.ts:868
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- ms: number = 300
Returns AsyncIterable<T>

buffer

buffer<T>(iter: AsyncIterable<T>, n: number, mode?: "count" | "time"): AsyncIterable<T[]>

- Defined in flu.ts:889
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- n: number
- mode: "count" | "time" = 'count'
Returns AsyncIterable<T[]>

breakBy

breakBy<T>(iter: AsyncIterable<T>, f?: (v: T) => unknown): AsyncIterable<T>

- Defined in flu.ts:925
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- Optional f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns AsyncIterable<T>

takeIf

takeIf<T>(iter: AsyncIterable<T>, f?: (v: T) => unknown): AsyncIterable<T>

- Defined in flu.ts:932
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- Optional f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns AsyncIterable<T>

skipIf

skipIf<T>(iter: AsyncIterable<T>, f: (v: T) => unknown): AsyncIterable<T>

- Defined in flu.ts:939
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns AsyncIterable<T>

startBy

startBy<T>(iter: AsyncIterable<T>, f: (v: T) => unknown): AsyncIterable<T>

- Defined in flu.ts:950
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns AsyncIterable<T>

drop

drop<T>(iter: AsyncIterable<T>): AsyncIterable<void>

- Defined in flu.ts:961
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns AsyncIterable<void>

forEnd

forEnd<T>(iter: AsyncIterable<T>): AsyncIterable<any>

- Defined in flu.ts:967
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
Returns AsyncIterable<any>

breakAt

breakAt<T>(iter: AsyncIterable<T>, single: PromiseLike<unknown> | AsyncIterable<unknown>): AsyncIterable<T>

- Defined in flu.ts:971
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- single: PromiseLike<unknown> | AsyncIterable<unknown>
Returns AsyncIterable<T>

startAt

startAt<T>(iter: AsyncIterable<T>, single: PromiseLike<unknown> | AsyncIterable<unknown>): AsyncIterable<T>

- Defined in flu.ts:992
Type parameters
- T
Parameters
- iter: AsyncIterable<T>
- single: PromiseLike<unknown> | AsyncIterable<unknown>
Returns AsyncIterable<T>

push

push<T>(a: AsyncIterable<T>, ...items: T[]): AsyncIterable<T>

- Defined in flu.ts:1013
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- Rest ...items: T[]
Returns AsyncIterable<T>

unshift

unshift<T>(a: AsyncIterable<T>, ...items: T[]): AsyncIterable<T>

- Defined in flu.ts:1018
Type parameters
- T
Parameters
- a: AsyncIterable<T>
- Rest ...items: T[]
Returns AsyncIterable<T>

as

as<T, U>(a: AsyncIterable<T>): AsyncIterable<U>

- Defined in flu.ts:1023
Type parameters
- T
- U
Parameters
- a: AsyncIterable<T>
Returns AsyncIterable<U>

groupBy

groupBy<T, K>(a: AsyncIterable<T>, keyf: (v: T) => K): AsyncIterable<[K, T[]]>
groupBy<T, K, V>(a: AsyncIterable<T>, keyf: (v: T) => K, valf: (v: T) => V): AsyncIterable<[K, V[]]>

- Defined in flu.ts:1027
Type parameters
- T
- K
Parameters
- a: AsyncIterable<T>
- keyf: (v: T) => K
  - - (v: T): K
    - Parameters
      - v: T
      Returns K
Returns AsyncIterable<[K, T[]]>
- Defined in flu.ts:1028
Type parameters
- T
- K
- V
Parameters
- a: AsyncIterable<T>
- keyf: (v: T) => K
  - - (v: T): K
    - Parameters
      - v: T
      Returns K
- valf: (v: T) => V
  - - (v: T): V
    - Parameters
      - v: T
      Returns V
Returns AsyncIterable<[K, V[]]>

toArray

toArray<T>(a: AsyncIterable<T>): Promise<T[]>

- Defined in flu.ts:1041
Type parameters
- T
Parameters
- a: AsyncIterable<T>
Returns Promise<T[]>

toSet

toSet<T>(a: AsyncIterable<T>): Promise<Set<T>>

- Defined in flu.ts:1045
Type parameters
- T
Parameters
- a: AsyncIterable<T>
Returns Promise<Set<T>>

toMap

toMap<K, V>(a: AsyncIterable<[K, V]>): Promise<Map<K, V>>

- Defined in flu.ts:1053
Type parameters
- K
- V
Parameters
- a: AsyncIterable<[K, V]>
Returns Promise<Map<K, V>>

Generated using TypeDoc