Class Stream<T>

Wrapper around IterableIterator interface offering a set of helpers to deal with iterations in a simple way

Remarks

Since 0.0.7

Type Parameters

Implements

IterableIterator<T>

Index

Constructors

constructor

Properties

Methods

[iterator] drop dropWhile every filter flatMap getNthOrLast has join map next take takeWhile nil of

Constructors

constructor

new Stream<T>(g): Stream<T>
Create a Stream based on g
Type Parameters
- T
Parameters
- g: IterableIterator<T>
 Underlying data of the Stream
Returns Stream<T>
- Defined in packages/fast-check/src/stream/Stream.ts:46

Properties

`Private` `Readonly` g

g: IterableIterator<T>

Underlying data of the Stream

Methods

[iterator]

[iterator](): IterableIterator<T>
Returns IterableIterator<T>
Implementation of IterableIterator.[iterator]
- Defined in packages/fast-check/src/stream/Stream.ts:58

drop

drop(n): Stream<T>
Drop n first elements of the Stream

WARNING: It closes the current stream
Parameters
- n: number
 Number of elements to drop
Returns Stream<T>
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:114

dropWhile

dropWhile(f): Stream<T>
Drop elements from the Stream while f(element) === true

WARNING: It closes the current stream
Parameters
- f: ((v) => boolean)
 Drop condition
 - - (v): boolean
 - Parameters
 v: T
 Returns boolean
Returns Stream<T>
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:96

every

every(f): boolean
Check whether all elements of the Stream are successful for f

WARNING: It closes the current stream
Parameters
- f: ((v) => boolean)
  Condition to check
  - - (v): boolean
    - Parameters
      v: T
      Returns boolean
Returns boolean
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:180

filter

filter(f): Stream
Filter elements of the Stream

WARNING: It closes the current stream
Type Parameters
- U
Parameters
- f: ((v) => v is U)
 Elements to keep
 - - (v): v is U
 - Parameters
 v: T
 Returns v is U
Returns Stream
Remarks
Since 1.23.0
- Defined in packages/fast-check/src/stream/Stream.ts:157
filter(f): Stream<T>
Filter elements of the Stream

WARNING: It closes the current stream
Parameters
- f: ((v) => boolean)
 Elements to keep
 - - (v): boolean
 - Parameters
 v: T
 Returns boolean
Returns Stream<T>
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:166

flatMap

flatMap(f): Stream
Flat map all elements of the Stream using f

WARNING: It closes the current stream
Type Parameters
- U
Parameters
- f: ((v) => IterableIterator)
 Mapper function
 - - (v): IterableIterator
 - Parameters
 v: T
 Returns IterableIterator
Returns Stream
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:83

getNthOrLast

getNthOrLast(nth): null | T
Take the nth element of the Stream of the last (if it does not exist)

WARNING: It closes the current stream
Parameters
- nth: number
  Position of the element to extract
Returns null | T
Remarks
Since 0.0.12
- Defined in packages/fast-check/src/stream/Stream.ts:228

has

has(f): [boolean, null | T]
Check whether one of the elements of the Stream is successful for f

WARNING: It closes the current stream
Parameters
- f: ((v) => boolean)
  Condition to check
  - - (v): boolean
    - Parameters
      v: T
      Returns boolean
Returns [boolean, null | T]
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:197

join

join(...others): Stream<T>
Join others Stream to the current Stream

WARNING: It closes the current stream and the other ones (as soon as it iterates over them)
Parameters
- Rest ...others: IterableIterator<T>[]
 Streams to join to the current Stream
Returns Stream<T>
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:215

map

map(f): Stream
Map all elements of the Stream using f

WARNING: It closes the current stream
Type Parameters
- U
Parameters
- f: ((v) => U)
 Mapper function
 - - (v): U
 - Parameters
 v: T
 Returns U
Returns Stream
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:71

next(): IteratorResult<T, any>
Returns IteratorResult<T, any>
Implementation of IterableIterator.next
- Defined in packages/fast-check/src/stream/Stream.ts:55

take

take(n): Stream<T>
Take n first elements of the Stream

WARNING: It closes the current stream
Parameters
- n: number
 Number of elements to take
Returns Stream<T>
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:144

takeWhile

takeWhile(f): Stream<T>
Take elements from the Stream while f(element) === true

WARNING: It closes the current stream
Parameters
- f: ((v) => boolean)
 Take condition
 - - (v): boolean
 - Parameters
 v: T
 Returns boolean
Returns Stream<T>
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:132

`Static` nil

nil<T>(): Stream<T>
Create an empty stream of T
Type Parameters
- T
Returns Stream<T>
Remarks
Since 0.0.1
- Defined in packages/fast-check/src/stream/Stream.ts:25

`Static` of

of<T>(...elements): Stream<T>
Create a stream of T from a variable number of elements
Type Parameters
- T
Parameters
- Rest ...elements: T[]
 Elements used to create the Stream
Returns Stream<T>
Remarks
Since 2.12.0
- Defined in packages/fast-check/src/stream/Stream.ts:35

Class Stream<T>

Remarks

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Stream<T>

Properties

Private Readonly g

Methods

[iterator]

Returns IterableIterator<T>

drop

Parameters

Returns Stream<T>

Remarks

dropWhile

Parameters

Parameters

Returns boolean

Returns Stream<T>

Remarks

every

Parameters

Parameters

Returns boolean

Returns boolean

Remarks

filter

Type Parameters

Parameters

Parameters

Returns v is U

Returns Stream<U>

Remarks

Parameters

Parameters

Returns boolean

Returns Stream<T>

Remarks

flatMap

Type Parameters

Parameters

Parameters

Returns IterableIterator<U>

Returns Stream<U>

Remarks

getNthOrLast

Parameters

Returns null | T

Remarks

has

Parameters

Parameters

Returns boolean

Returns [boolean, null | T]

Remarks

join

Parameters

Returns Stream<T>

Remarks

map

Type Parameters

Parameters

Parameters

Returns U

Returns Stream<U>

Remarks

next

Returns IteratorResult<T, any>

take

Parameters

Returns Stream<T>

Remarks

`Private` `Readonly` g

`Static` nil

`Static` of