Module seq/ops

Functions

of

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

- Defined in seq/ops.ts:6
Type parameters
- T
Parameters
- Rest ...iter: T[]
Returns Iterable<T>

collect

collect<T>(iter: Iterable<T>): T[]

- Defined in seq/ops.ts:10
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns T[]

join

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

- Defined in seq/ops.ts:14
Type parameters
- T
Parameters
- iter: Iterable<T>
- Optional separator: string
Returns string

count

count<T>(iter: Iterable<T>): number

- Defined in seq/ops.ts:18
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns number

isEmpty

isEmpty<T>(iter: Iterable<T>): boolean

- Defined in seq/ops.ts:26
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns boolean

first

first<T>(iter: Iterable<T>): Voidable<T>

- Defined in seq/ops.ts:33
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns Voidable<T>

firstO

firstO<T>(iter: Iterable<T>): Option<T>

- Defined in seq/ops.ts:37
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns Option<T>

last

last<T>(iter: Iterable<T>): Voidable<T>

- Defined in seq/ops.ts:42
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns Voidable<T>

lastO

lastO<T>(iter: Iterable<T>): Option<T>

- Defined in seq/ops.ts:51
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns Option<T>

nth

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

- Defined in seq/ops.ts:61
Type parameters
- T
Parameters
- iter: Iterable<T>
- n: number
Returns Voidable<T>

nthO

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

- Defined in seq/ops.ts:71
Type parameters
- T
Parameters
- iter: Iterable<T>
- n: number
Returns Option<T>

stepBy

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

- Defined in seq/ops.ts:81
Type parameters
- T
Parameters
- iter: Iterable<T>
- step: number
Returns Iterable<T>

chain

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

- Defined in seq/ops.ts:95
Type parameters
- T
Parameters
- a: Iterable<T>
- b: Iterable<T>
- Rest ...more: Iterable<T>[]
Returns Iterable<T>

zip

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

- Defined in seq/ops.ts:103
Type parameters
- A
- B
Parameters
- a: Iterable<A>
- b: Iterable<B>
Returns Iterable<[A, B]>

unzip

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

- Defined in seq/ops.ts:115
Type parameters
- A
- B
Parameters
- iter: Iterable<[A, B]>
Returns [A[], B[]]

map

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

- Defined in seq/ops.ts:124
Type parameters
- T
- R
Parameters
- iter: Iterable<T>
- f: (v: T) => R
  - - (v: T): R
    - Parameters
      - v: T
      Returns R
Returns Iterable<R>

fill

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

- Defined in seq/ops.ts:130
Type parameters
- T
- R
Parameters
- iter: Iterable<T>
- v: R
Returns Iterable<R>

forEach

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

- Defined in seq/ops.ts:136
Type parameters
- T
Parameters
- iter: Iterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns void

run

run<T>(iter: Iterable<T>): void

- Defined in seq/ops.ts:142
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns void

filter

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

- Defined in seq/ops.ts:146
Type parameters
- T
- S
Parameters
- iter: Iterable<T>
- f: (v: T) => v is S
  - - (v: T): v is S
    - Parameters
      - v: T
      Returns v is S
Returns Iterable<S>
- Defined in seq/ops.ts:147
Type parameters
- T
Parameters
- iter: Iterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns Iterable<T>

enumerate

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

- Defined in seq/ops.ts:154
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns Iterable<[T, number]>

indexed

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

- Defined in seq/ops.ts:162
Type parameters
- T
Parameters
- iter: Iterable<T>
Returns Iterable<[number, T]>

skip

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

- Defined in seq/ops.ts:170
Type parameters
- T
Parameters
- iter: Iterable<T>
- n: number
Returns Iterable<T>

take

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

- Defined in seq/ops.ts:176
Type parameters
- T
Parameters
- iter: Iterable<T>
- n: number
Returns Iterable<T>

slice

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

- Defined in seq/ops.ts:183
Type parameters
- T
Parameters
- iter: Iterable<T>
- from: number
- to: number
Returns Iterable<T>

sub

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

- Defined in seq/ops.ts:190
Type parameters
- T
Parameters
- iter: Iterable<T>
- from: number
- count: number
Returns Iterable<T>

scan

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

- Defined in seq/ops.ts:195
Type parameters
- T
- R
Parameters
- iter: Iterable<T>
- init: R
- f: (acc: R, val: T) => R
  - - (acc: R, val: T): R
    - Parameters
      - acc: R
      - val: T
      Returns R
Returns Iterable<R>

flatMap

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

- Defined in seq/ops.ts:203
Type parameters
- T
- R
Parameters
- iter: Iterable<T>
- f: (v: T) => Iterable<R>
  - - (v: T): Iterable<R>
    - Parameters
      - v: T
      Returns Iterable<R>
Returns Iterable<R>

flatten

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

- Defined in seq/ops.ts:209
Type parameters
- T
Parameters
- iter: Iterable<Iterable<T>>
Returns Iterable<T>

also

also<T>(iter: Iterable<T>, f: (v: T) => void): Iterable<T>

- Defined in seq/ops.ts:215
Type parameters
- T
Parameters
- iter: Iterable<T>
- f: (v: T) => void
  - - (v: T): void
    - Parameters
      - v: T
      Returns void
Returns Iterable<T>

fold

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

- Defined in seq/ops.ts:222
Type parameters
- T
- R
Parameters
- a: Iterable<T>
- init: R
- f: (acc: R, val: T) => R
  - - (acc: R, val: T): R
    - Parameters
      - acc: R
      - val: T
      Returns R
Returns R

reduce

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

- Defined in seq/ops.ts:230
Type parameters
- T
Parameters
- a: Iterable<T>
- f: (acc: T, val: T) => T
  - - (acc: T, val: T): T
    - Parameters
      - acc: T
      - val: T
      Returns T
Returns T

all

all<T, S>(a: Iterable<T>, f: (v: T) => v is S): a is Iterable<S>
all<T>(a: Iterable<T>, f: (v: T) => unknown): boolean

- Defined in seq/ops.ts:239
Type parameters
- T
- S
Parameters
- a: Iterable<T>
- f: (v: T) => v is S
  - - (v: T): v is S
    - Parameters
      - v: T
      Returns v is S
Returns a is Iterable<S>
- Defined in seq/ops.ts:240
Type parameters
- T
Parameters
- a: Iterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns boolean

any

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

- Defined in seq/ops.ts:248
Type parameters
- T
Parameters
- a: Iterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns boolean

find

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

- Defined in seq/ops.ts:255
Type parameters
- T
Parameters
- a: Iterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns Voidable<T>

findO

findO<T>(a: Iterable<T>, f: (v: T) => unknown): Option<T>

- Defined in seq/ops.ts:261
Type parameters
- T
Parameters
- a: Iterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns Option<T>

position

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

- Defined in seq/ops.ts:268
Type parameters
- T
Parameters
- a: Iterable<T>
- f: (v: T) => unknown
  - - (v: T): unknown
    - Parameters
      - v: T
      Returns unknown
Returns number

indexOf

indexOf<T>(a: Iterable<T>, v: T): number

- Defined in seq/ops.ts:275
Type parameters
- T
Parameters
- a: Iterable<T>
- v: T
Returns number

includes

includes<T>(a: Iterable<T>, v: T): boolean

- Defined in seq/ops.ts:282
Type parameters
- T
Parameters
- a: Iterable<T>
- v: T
Returns boolean

max

max<T>(a: Iterable<T>): Voidable<T>

- Defined in seq/ops.ts:289
Type parameters
- T
Parameters
- a: Iterable<T>
Returns Voidable<T>

maxO

maxO<T>(a: Iterable<T>): Option<T>

- Defined in seq/ops.ts:298
Type parameters
- T
Parameters
- a: Iterable<T>
Returns Option<T>

min

min<T>(a: Iterable<T>): Voidable<T>

- Defined in seq/ops.ts:307
Type parameters
- T
Parameters
- a: Iterable<T>
Returns Voidable<T>

minO

minO<T>(a: Iterable<T>): Option<T>

- Defined in seq/ops.ts:316
Type parameters
- T
Parameters
- a: Iterable<T>
Returns Option<T>

sum

sum<T>(a: Iterable<T>, defv: T): T
sum<T>(a: Iterable<T>): Voidable<T>

- Defined in seq/ops.ts:325
Type parameters
- T: string | number | bigint
Parameters
- a: Iterable<T>
- defv: T
Returns T
- Defined in seq/ops.ts:326
Type parameters
- T: string | number | bigint
Parameters
- a: Iterable<T>
Returns Voidable<T>

avg

avg<T>(a: Iterable<T>, defv: T): T
avg<T>(a: Iterable<T>): Voidable<T>

- Defined in seq/ops.ts:336
Type parameters
- T: number | bigint
Parameters
- a: Iterable<T>
- defv: T
Returns T
- Defined in seq/ops.ts:337
Type parameters
- T: number | bigint
Parameters
- a: Iterable<T>
Returns Voidable<T>

push

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

- Defined in seq/ops.ts:350
Type parameters
- T
Parameters
- a: Iterable<T>
- Rest ...items: T[]
Returns Iterable<T>

unshift

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

- Defined in seq/ops.ts:355
Type parameters
- T
Parameters
- a: Iterable<T>
- Rest ...items: T[]
Returns Iterable<T>

as

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

- Defined in seq/ops.ts:360
Type parameters
- T
- U
Parameters
- a: Iterable<T>
Returns Iterable<U>

toArray

toArray<T>(a: Iterable<T>): T[]

- Defined in seq/ops.ts:364
Type parameters
- T
Parameters
- a: Iterable<T>
Returns T[]

toSet

toSet<T>(a: Iterable<T>): Set<T>

- Defined in seq/ops.ts:369
Type parameters
- T
Parameters
- a: Iterable<T>
Returns Set<T>

toMap

toMap<K, V>(a: Iterable<[K, V]>): Map<K, V>
toMap<K, V>(a: Iterable<readonly [K, V]>): Map<K, V>
toMap<K, V>(a: Iterable<[K, V] | readonly [K, V]>): Map<K, V>

- Defined in seq/ops.ts:374
Type parameters
- K
- V
Parameters
- a: Iterable<[K, V]>
Returns Map<K, V>
- Defined in seq/ops.ts:375
Type parameters
- K
- V
Parameters
- a: Iterable<readonly [K, V]>
Returns Map<K, V>
- Defined in seq/ops.ts:376
Type parameters
- K
- V
Parameters
- a: Iterable<[K, V] | readonly [K, V]>
Returns Map<K, V>

product

product<O>(...iters: O): Iterable<ArrayGuard<{ [ K in keyof O]: O[K] extends Iterable<infer T> ? T : never }>>
product<T>(...iters: Iterable<T>[]): Iterable<T[]>

- Defined in seq/ops.ts:384
Cartesian product

Type parameters
- O: Iterable<any>[]
Parameters
- Rest ...iters: O
Returns Iterable<ArrayGuard<{ [ K in keyof O]: O[K] extends Iterable<infer T> ? T : never }>>
- Defined in seq/ops.ts:385
Type parameters
- T
Parameters
- Rest ...iters: Iterable<T>[]
Returns Iterable<T[]>

groupBy

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

- Defined in seq/ops.ts:410
Type parameters
- T
- K
Parameters
- a: Iterable<T>
- keyf: (v: T) => K
  - - (v: T): K
    - Parameters
      - v: T
      Returns K
Returns Iterable<[K, T[]]>
- Defined in seq/ops.ts:411
Type parameters
- T
- K
- V
Parameters
- a: Iterable<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 Iterable<[K, V[]]>

relate

relate<O, I, K>(outer: Iterable<O>, inner: Iterable<I>, outerKey: (a: O) => K, innerKey: (b: I) => K): Iterable<[O, I]>

- Defined in seq/ops.ts:425
sql inner join

Type parameters
- O
- I
- K
Parameters
- outer: Iterable<O>
- inner: Iterable<I>
- outerKey: (a: O) => K
  - - (a: O): K
    - Parameters
      - a: O
      Returns K
- innerKey: (b: I) => K
  - - (b: I): K
    - Parameters
      - b: I
      Returns K
Returns Iterable<[O, I]>

relateMap

relateMap<O, I, K, R>(outer: Iterable<O>, inner: Iterable<I>, outerKey: (a: O) => K, innerKey: (b: I) => K, selector: (a: O, b: I) => R): Iterable<R>

- Defined in seq/ops.ts:430
sql inner join

Type parameters
- O
- I
- K
- R
Parameters
- outer: Iterable<O>
- inner: Iterable<I>
- outerKey: (a: O) => K
  - - (a: O): K
    - Parameters
      - a: O
      Returns K
- innerKey: (b: I) => K
  - - (b: I): K
    - Parameters
      - b: I
      Returns K
- selector: (a: O, b: I) => R
  - - (a: O, b: I): R
    - Parameters
      - a: O
      - b: I
      Returns R
Returns Iterable<R>

mapKey

mapKey<K, V, R>(iter: Iterable<[K, V]>, f: (key: K) => R): Iterable<[R, V]>
mapKey<K, V, R>(iter: Iterable<readonly [K, V]>, f: (key: K) => R): Iterable<[R, V]>
mapKey<K, V, R>(iter: Iterable<AnyPair<K, V>>, f: (key: K) => R): Iterable<[R, V]>

- Defined in seq/ops.ts:480
Type parameters
- K
- V
- R
Parameters
- iter: Iterable<[K, V]>
- f: (key: K) => R
  - - (key: K): R
    - Parameters
      - key: K
      Returns R
Returns Iterable<[R, V]>
- Defined in seq/ops.ts:481
Type parameters
- K
- V
- R
Parameters
- iter: Iterable<readonly [K, V]>
- f: (key: K) => R
  - - (key: K): R
    - Parameters
      - key: K
      Returns R
Returns Iterable<[R, V]>
- Defined in seq/ops.ts:482
Type parameters
- K
- V
- R
Parameters
- iter: Iterable<AnyPair<K, V>>
- f: (key: K) => R
  - - (key: K): R
    - Parameters
      - key: K
      Returns R
Returns Iterable<[R, V]>

mapValue

mapValue<K, V, R>(iter: Iterable<[K, V]>, f: (val: V) => R): Iterable<[K, R]>
mapValue<K, V, R>(iter: Iterable<readonly [K, V]>, f: (val: V) => R): Iterable<[K, R]>
mapValue<K, V, R>(iter: Iterable<AnyPair<K, V>>, f: (val: V) => R): Iterable<[K, R]>

- Defined in seq/ops.ts:489
Type parameters
- K
- V
- R
Parameters
- iter: Iterable<[K, V]>
- f: (val: V) => R
  - - (val: V): R
    - Parameters
      - val: V
      Returns R
Returns Iterable<[K, R]>
- Defined in seq/ops.ts:490
Type parameters
- K
- V
- R
Parameters
- iter: Iterable<readonly [K, V]>
- f: (val: V) => R
  - - (val: V): R
    - Parameters
      - val: V
      Returns R
Returns Iterable<[K, R]>
- Defined in seq/ops.ts:491
Type parameters
- K
- V
- R
Parameters
- iter: Iterable<AnyPair<K, V>>
- f: (val: V) => R
  - - (val: V): R
    - Parameters
      - val: V
      Returns R
Returns Iterable<[K, R]>

Generated using TypeDoc