README.md

map module

Type aliases

• Map
• MapFunction

Functions

• map

Type aliases

Map

Ƭ Map: function

Defined in index.ts:17

Map function (creates transformed stream)

Type declaration:

▸ (iterable: Iterable‹S›): IterableIterator‹D›

Parameters:

Name	Type	Description
iterable	Iterable‹S›	input stream

---

MapFunction

Ƭ MapFunction: function

Defined in index.ts:6

Function to transform item of a stream

Type declaration:

▸ (item: S, index: number): D

Parameters:

Name	Type	Description
item	S	item to transform
index	number	item index in stream

Functions

map

▸ map‹S, D›(mapFn: MapFunction‹S, D›): Map‹S, D›

Defined in index.ts:30

Function to create transformed stream

Type parameters:

▪ S

▪ D

Parameters:

Name	Type	Description
mapFn	MapFunction‹S, D›	function to transform item

Returns: Map‹S, D›

map function to transform stream

▸ map‹S, D›(mapFn: MapFunction‹S, D›, iterable: Iterable‹S›): IterableIterator‹D›

Defined in index.ts:38

Function to create transformed stream

Type parameters:

▪ S

▪ D

Parameters:

Name	Type	Description
mapFn	MapFunction‹S, D›	function to transform item
iterable	Iterable‹S›	input stream

Returns: IterableIterator‹D›

output transformed stream