types.mapper.md

@wholebuzz/mapreduce / Exports / types / Mapper

Interface: Mapper<Key, Value>

types.Mapper

Type parameters

Name
Key
Value

Hierarchy

• Base<Key, Value>

  ↳ Mapper

Implemented by

• AsyncIterableMapper
• IdentityMapper
• IterableMapper
• TransformMapper

Table of contents

Properties

• cleanup
• configure
• map
• setup

Properties

cleanup

• Optional cleanup: (context: Context<Key, Value>) => Promise<void>

Type declaration

▸ (context: Context<Key, Value>): Promise<void>

Parameters

Name	Type
context	Context<Key, Value>

Returns: Promise<void>

Inherited from: Base.cleanup

Defined in: src/types.ts:24

---

configure

• Optional configure: (config: MapReduceRuntimeConfig<Key, Value>) => void

Type declaration

▸ (config: MapReduceRuntimeConfig<Key, Value>): void

Parameters

Name	Type
config	MapReduceRuntimeConfig<Key, Value>

Returns: void

Inherited from: Base.configure

Defined in: src/types.ts:22

---

map

• map: (key: Key, value: Value, context: MapContext<Key, Value>) => void | Promise<void>

Type declaration

▸ (key: Key, value: Value, context: MapContext<Key, Value>): void | Promise<void>

Parameters

Name	Type
key	Key
value	Value
context	MapContext<Key, Value>

Returns: void | Promise<void>

Defined in: src/types.ts:49

---

setup

• Optional setup: (context: Context<Key, Value>) => Promise<void>

Type declaration

▸ (context: Context<Key, Value>): Promise<void>

Parameters

Name	Type
context	Context<Key, Value>

Returns: Promise<void>

Inherited from: Base.setup

Defined in: src/types.ts:23