Class GenericSequenceProcessor<T>

Type Parameters

T extends [Path, Value] | [Path, Value, number, number]

Hierarchy (View Summary)

GenericBatchIterable
- GenericSequenceProcessor
  - StreamSequenceProcessor
  - ObjectSequenceProcessor

Index

Constructors

constructor

new GenericSequenceProcessor<
    T extends [Path, Value]
    | [Path, Value, number, number],
>(
    _iterable?:
        | GenericBatchIterable<T>
        | AsyncIterable<Iterable<T, any, any>, any, any>
        | Iterable<Iterable<T, any, any>, any, any>,
): GenericSequenceProcessor<T>
Type Parameters
- T extends [Path, Value] | [Path, Value, number, number]
Parameters
- Optional_iterable:
      | GenericBatchIterable<T>
      | AsyncIterable<Iterable<T, any, any>, any, any>
      | Iterable<Iterable<T, any, any>, any, any>
Returns GenericSequenceProcessor<T>
Inherited from GenericBatchIterable.constructor
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:9

Properties

iterable

iterable: AsyncIterable<Iterable<T, any, any>>

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterator<Iterable<T, any, any>, any, any>
Returns AsyncIterator<Iterable<T, any, any>, any, any>
Inherited from GenericBatchIterable.[asyncIterator]
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:86

drop

drop(n: number): this
Parameters
- n: number
Returns this
Inherited from GenericBatchIterable.drop
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:26

every

every(predicate: (item: T, index: number) => boolean): Promise<boolean>
Parameters
- predicate: (item: T, index: number) => boolean
Returns Promise<boolean>
Inherited from GenericBatchIterable.every
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:61

filter

filter(func: (item: T, index: number) => boolean): this
Parameters
- func: (item: T, index: number) => boolean
Returns this
Inherited from GenericBatchIterable.filter
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:31

find

find(predicate: (item: T, index: number) => boolean): Promise<undefined | T>
Parameters
- predicate: (item: T, index: number) => boolean
Returns Promise<undefined | T>
Inherited from GenericBatchIterable.find
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:71

flatMap

flatMap(func: (item: T, index: number) => T | Iterable<T, any, any>): this
Parameters
- func: (item: T, index: number) => T | Iterable<T, any, any>
Returns this
Inherited from GenericBatchIterable.flatMap
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:41

forEach

forEach(func: (item: T, index: number) => void): Promise<void>
Parameters
- func: (item: T, index: number) => void
Returns Promise<void>
Inherited from GenericBatchIterable.forEach
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:46

includes

includes(expression?: string | MatcherContainer): GenericSequenceProcessor<T>
It filters the sequence based on the given expression
Parameters
- Optionalexpression: string | MatcherContainer
Returns GenericSequenceProcessor<T>
- Defined in src/SequenceProcessor/index.js:20

map

map(func: (item: T, index: number) => T): this
Parameters
- func: (item: T, index: number) => T
Returns this
Inherited from GenericBatchIterable.map
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:36

reduce

reduce<U>(
func: (acc: U, item: T, index: number) => U,
initialValue?: U,
): Promise<U>
Type Parameters
- U
Parameters
- func: (acc: U, item: T, index: number) => U
- OptionalinitialValue: U
Returns Promise<U>
Inherited from GenericBatchIterable.reduce
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:53

some

some(predicate: (item: T, index: number) => boolean): Promise<boolean>
Parameters
- predicate: (item: T, index: number) => boolean
Returns Promise<boolean>
Inherited from GenericBatchIterable.some
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:66

take

take(n: number): this
Parameters
- n: number
Returns this
Inherited from GenericBatchIterable.take
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:21

toArray

toArray(): Promise<T[]>
Returns Promise<T[]>
Inherited from GenericBatchIterable.toArray
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:75

toAsyncIterable

toAsyncIterable(): AsyncIterable<T>
Returns AsyncIterable<T>
Inherited from GenericBatchIterable.toAsyncIterable
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:79

toBatchIterable

toBatchIterable(): GenericBatchIterable<any>
Returns a general purpose batchiterable which is less strict in typing but lacks methods that requires the correct types to be enforced

Returns GenericBatchIterable<any>
Inherited from GenericBatchIterable.toBatchIterable
- Defined in node_modules/batch-iterable/types/src/GenericBatchIterable.d.ts:85

toIterableBuffer

toIterableBuffer(): BatchIterable
Build an stream back from the sequence

Returns BatchIterable
- Defined in src/SequenceProcessor/index.js:45

toObject

toObject(obj?: any): Promise<any>
Build an object back from the sequence
Parameters
- Optionalobj: any = undefined
  Options for the sequence to object conversion
Returns Promise<any>
- Defined in src/SequenceProcessor/index.js:32

Class GenericSequenceProcessor<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns GenericSequenceProcessor<T>

Properties

iterable

Methods

[asyncIterator]

Returns AsyncIterator<Iterable<T, any, any>, any, any>

drop

Parameters

Returns this

every

Parameters

Returns Promise<boolean>

filter

Parameters

Returns this

find

Parameters

Returns Promise<undefined | T>

flatMap

Parameters

Returns this

forEach

Parameters

Returns Promise<void>

includes

Parameters

Returns GenericSequenceProcessor<T>

map

Parameters

Returns this

reduce

Type Parameters

Parameters

Returns Promise<U>

some

Parameters

Returns Promise<boolean>

take

Parameters

Returns this

toArray

Returns Promise<T[]>

toAsyncIterable

Returns AsyncIterable<T>

toBatchIterable

Returns GenericBatchIterable<any>

toIterableBuffer

Returns BatchIterable

toObject

Parameters

Returns Promise<any>

Settings

On This Page