Seq | js-seq v0.0.6

Class as representation of a lazy sequence.

This implementation does not use ES2015 generators/iterators, because the ES2015 feature "for (const item of seq)" has a really poor performance.

See: https://jsfiddle.net/vavkuoLp/

License: Public Domain

Type parameters

T

Hierarchy

Seq

Implements

Iterable<T>

Index

Methods

Methods

__@iterator

__@iterator(): Iterator<T>

- Defined in Seq.ts:26
Returns Iterator<T>

count

count(): number

- Defined in Seq.ts:229
Returns number

filter

filter(pred: function): Seq<T>

- Defined in Seq.ts:108
Filters items of a sequence by a given predicate.

example

let items = Seq.of(1, 2, 4, 8, 16, 32); let result = items.filter(x => x < 10); // 1, 2, 4, 8

Parameters
- pred: function
  
  The predicate function
  - - (item: T, index: number): boolean
    - Parameters
      - item: T
      - index: number
      Returns boolean
Returns Seq<T>

Sequence of the filtered items

flatMap

flatMap<R>(f: function): Seq<R>

- Defined in Seq.ts:132
Type parameters
- R
Parameters
- f: function
  - - (item: T): Seq<R>
    - Parameters
      - item: T
      Returns Seq<R>
Returns Seq<R>

forEach

forEach(action: function): void

- Defined in Seq.ts:237
Parameters
- action: function
  - - (item: T, index: number): void
    - Parameters
      - item: T
      - index: number
      Returns void
Returns void

force

force(): Seq<T>

- Defined in Seq.ts:269
Returns Seq<T>

map

map<R>(f: function): Seq<R>

- Defined in Seq.ts:75
Maps each value of the seq

method

Seq.map

Type parameters
- R
Parameters
- f: function
  
  Mapping function
  - - (item: T, index: number): R
    - Parameters
      - item: T
      - index: number
      Returns R
Returns Seq<R>

Seq of the mapped values

reduce

reduce(f: function, seed?: T): T

- Defined in Seq.ts:198
Parameters
- f: function
  - - (a: T, b: T): T
    - Parameters
      - a: T
      - b: T
      Returns T
- Optional seed: T
Returns T

skip

skip(n: number): Seq<T>

- Defined in Seq.ts:194
Parameters
- n: number
Returns Seq<T>

skipWhile

skipWhile(pred: function): Seq<T>

- Defined in Seq.ts:158
Parameters
- pred: function
  - - (item: T, index: number): boolean
    - Parameters
      - item: T
      - index: number
      Returns boolean
Returns Seq<T>

take

take(n: number): Seq<T>

- Defined in Seq.ts:190
Parameters
- n: number
Returns Seq<T>

takeWhile

takeWhile(pred: function): Seq<T>

- Defined in Seq.ts:136
Parameters
- pred: function
  - - (item: T, index: number): boolean
    - Parameters
      - item: T
      - index: number
      Returns boolean
Returns Seq<T>

toArray

toArray(): T[]

- Defined in Seq.ts:261
Returns T[]

toString

toString(): string

- Defined in Seq.ts:22
Returns string

Static adjust

adjust<T>(it: T | Iterable<T>): Seq<T>

- Defined in Seq.ts:342
Type parameters
- T
Parameters
- it: T | Iterable<T>
Returns Seq<T>

Static concat

concat<T>(...seqs: Iterable<T>[]): Seq<T>

- Defined in Seq.ts:358
Type parameters
- T
Parameters
- Rest ...seqs: Iterable<T>[]
Returns Seq<T>

Static empty

empty(): Seq<any>

- Defined in Seq.ts:277
Returns Seq<any>

Static flatten

flatten<T>(seqOfSeqs: Iterable<Iterable<T>>): Seq<T>

- Defined in Seq.ts:362
Type parameters
- T
Parameters
- seqOfSeqs: Iterable<Iterable<T>>
Returns Seq<T>

Static from

from<T>(items: Iterable<T> | function): Seq<T>

- Defined in Seq.ts:285
Type parameters
- T
Parameters
- items: Iterable<T> | function
Returns Seq<T>

Static isSeqable

isSeqable(obj: any): boolean

- Defined in Seq.ts:455
Parameters
- obj: any
Returns boolean

Static isSeqableObject

isSeqableObject(obj: any): boolean

- Defined in Seq.ts:459
Parameters
- obj: any
Returns boolean

Static iterate

iterate<T>(initialValues: T[], f: function): Seq<T>

- Defined in Seq.ts:413
Type parameters
- T
Parameters
- initialValues: T[]
- f: function
  - - (...args: T[]): T
    - Parameters
      - Rest ...args: T[]
      Returns T
Returns Seq<T>

Static of

of<T>(...items: T[]): Seq<T>

- Defined in Seq.ts:281
Type parameters
- T
Parameters
- Rest ...items: T[]
Returns Seq<T>

Static range

range(start: number, end?: number, step?: number): Seq<number>

- Defined in Seq.ts:443
Creates a seq of numeric values from a start value (including) to an end value (excluding).

example

Seq.range(1, 10) // 1, 2, 3, 4, 5, 6, 7, 8, 9 Seq.range(0, -8, -2) // 0, -2, -4, -6

method

Seq.range

Parameters
- start: number
  
  Start value
- Default value end: number = null
  
  End value
- Default value step: number = 1
Returns Seq<number>

Seq of iterated values

Static repeat

repeat<T>(value: T, n?: number): Seq<T>

- Defined in Seq.ts:426
Type parameters
- T
Parameters
- value: T
- Default value n: number = Infinity
Returns Seq<T>

Static toString

toString(): String

- Defined in Seq.ts:273
Returns String

Generated using TypeDoc