filter module
Type aliases
Functions
Type aliases
Filter
Ƭ Filter: function
Defined in index.ts:17
Filter function (creates filtered stream)
Type declaration:
▸ (iterable: Iterable‹T›): IterableIterator‹T›
Parameters:
| Name | Type | Description | |
|---|---|---|---|
iterable |
Iterable‹T› | input stream |
FilterFunction
Ƭ FilterFunction: function
Defined in index.ts:6
Filter predicate
Type declaration:
▸ (item: T, index: number): boolean
Parameters:
| Name | Type | Description | |
|---|---|---|---|
item |
T | item to filter | |
index |
number | item index in stream |
Functions
filter
▸ filter‹T›(filterFn: FilterFunction‹T›): Filter‹T›
Defined in index.ts:30
Function to create filtered stream
Type parameters:
▪ T
Parameters:
| Name | Type | Description | |
|---|---|---|---|
filterFn |
FilterFunction‹T› | filter predicate |
Returns: Filter‹T›
filter function
▸ filter‹T›(filterFn: FilterFunction‹T›, iterable: Iterable‹T›): IterableIterator‹T›
Defined in index.ts:38
Function to create filtered stream
Type parameters:
▪ T
Parameters:
| Name | Type | Description | |
|---|---|---|---|
filterFn |
FilterFunction‹T› | filter predicate | |
iterable |
Iterable‹T› | input stream |
Returns: IterableIterator‹T›
output filtered stream