runtime.md

@wholebuzz/mapreduce / Exports / runtime

Module: runtime

Table of contents

Variables

• defaultDiretory
• defaultKeyProperty
• defaultShuffleFormat
• defaultValueProperty
• inputshardFilenameFormat
• localTempDirectoryPrefix
• maxIntegerDigits
• shuffleFilenameFormat
• synchronizeMapFilenameFormat
• synchronizeReduceFilenameFormat
• unknownWriteProperty

Functions

• formatNumberForUtf8Sort
• getConfigurationValue
• getItemKeyAccessor
• getItemValueAccessor
• getName
• getShardFilter
• getUser
• getWorkDirectory
• immutableContext
• mapTransform
• mappedObject
• newJobId
• prepareRuntime
• reduceTransform

Variables

defaultDiretory

• Const defaultDiretory: "./"= './'

Defined in: src/runtime.ts:25

---

defaultKeyProperty

• Const defaultKeyProperty: "key"= 'key'

Defined in: src/runtime.ts:26

---

defaultShuffleFormat

• Const defaultShuffleFormat: "jsonl.gz"= 'jsonl.gz'

Defined in: src/runtime.ts:29

---

defaultValueProperty

• Const defaultValueProperty: ""= ''

Defined in: src/runtime.ts:27

---

inputshardFilenameFormat

• Const inputshardFilenameFormat: "inputshard-SSSS-of-NNNN"= 'inputshard-SSSS-of-NNNN'

Defined in: src/runtime.ts:31

---

localTempDirectoryPrefix

• Const localTempDirectoryPrefix: "maptmp"= 'maptmp'

Defined in: src/runtime.ts:34

---

maxIntegerDigits

• Const maxIntegerDigits: number

Defined in: src/runtime.ts:76

---

shuffleFilenameFormat

• Const shuffleFilenameFormat: "shuffle-SSSS-of-NNNN"= 'shuffle-SSSS-of-NNNN'

Defined in: src/runtime.ts:30

---

synchronizeMapFilenameFormat

• Const synchronizeMapFilenameFormat: "map-done-SSSS-of-NNNN.json"= 'map-done-SSSS-of-NNNN.json'

Defined in: src/runtime.ts:32

---

synchronizeReduceFilenameFormat

• Const synchronizeReduceFilenameFormat: "reduce-done-SSSS-of-NNNN.json"= 'reduce-done-SSSS-of-NNNN.json'

Defined in: src/runtime.ts:33

---

unknownWriteProperty

• Const unknownWriteProperty: "value"= 'value'

Defined in: src/runtime.ts:28

Functions

formatNumberForUtf8Sort

▸ Const formatNumberForUtf8Sort(value: number, reverse?: boolean): string

Parameters

Name	Type
value	number
reverse?	boolean

Returns: string

Defined in: src/runtime.ts:78

---

getConfigurationValue

▸ getConfigurationValue<X>(configuration: Configuration | undefined, key: string, type?: string): X

Type parameters

Name
X

Parameters

Name	Type
configuration	Configuration | undefined
key	string
type?	string

Returns: X

Defined in: src/runtime.ts:52

---

getItemKeyAccessor

▸ Const getItemKeyAccessor(inputKeyProperty?: string): function

Parameters

Name	Type
inputKeyProperty?	string

Returns: (_: Record<string, any>) => any

Defined in: src/runtime.ts:69

---

getItemValueAccessor

▸ Const getItemValueAccessor(inputValueProperty?: string): function

Parameters

Name	Type
inputValueProperty?	string

Returns: (_: Record<string, any>) => any

Defined in: src/runtime.ts:72

---

getName

▸ getName(name?: string): string

Parameters

Name	Type
name?	string

Returns: string

Defined in: src/runtime.ts:40

---

getShardFilter

▸ getShardFilter(workerIndex: number, numWorkers: number): undefined | (index: number) => boolean

Parameters

Name	Type
workerIndex	number
numWorkers	number

Returns: undefined | (index: number) => boolean

Defined in: src/runtime.ts:65

---

getUser

▸ getUser(user?: string): string

Parameters

Name	Type
user?	string

Returns: string

Defined in: src/runtime.ts:44

---

getWorkDirectory

▸ getWorkDirectory(user: string, jobid: string): string

Parameters

Name	Type
user	string
jobid	string

Returns: string

Defined in: src/runtime.ts:48

---

immutableContext

▸ Const immutableContext(configuration?: Configuration): object

Parameters

Name	Type
configuration?	Configuration

Returns: object

Name	Type
configuration	Configuration
currentItem	object
keyProperty	string
valueProperty	string
write	() => never

Defined in: src/runtime.ts:134

---

mapTransform

▸ mapTransform<Key, Value>(mapper: Mapper<Key, Value>, args?: { configuration?: Configuration ; logger?: Logger ; transform?: (value: Item) => Item }): Transform

Type parameters

Name
Key
Value

Parameters

Name	Type
mapper	Mapper<Key, Value>
args?	object
args.configuration?	Configuration
args.logger?	Logger
args.transform?	(value: Item) => Item

Returns: Transform

Defined in: src/runtime.ts:156

---

mappedObject

▸ mappedObject<Key, _Value>(key: Key, value: any, keySetter: (output: Record<string, any>, value: any) => void | undefined, nonObjectValueSetter: (output: Record<string, any>, value: any) => void, transform?: (value: Item) => Item): Item

Type parameters

Name
Key
_Value

Parameters

Name	Type
key	Key
value	any
keySetter	(output: Record<string, any>, value: any) => void | undefined
nonObjectValueSetter	(output: Record<string, any>, value: any) => void
transform?	(value: Item) => Item

Returns: Item

Defined in: src/runtime.ts:144

---

newJobId

▸ newJobId(name?: string): string

Parameters

Name	Type
name?	string

Returns: string

Defined in: src/runtime.ts:36

---

prepareRuntime

▸ prepareRuntime<Key, Value>(fileSystem: FileSystem, logger: Logger, args: MapReduceJobConfig): Promise<MapReduceRuntimeConfig<Key, Value>>

Type parameters

Name
Key
Value

Parameters

Name	Type
fileSystem	FileSystem
logger	Logger
args	MapReduceJobConfig

Returns: Promise<MapReduceRuntimeConfig<Key, Value>>

Defined in: src/runtime.ts:81

---

reduceTransform

▸ reduceTransform<Key, Value>(reducer: Reducer<Key, Value>, args: { configuration?: Configuration ; logger?: Logger ; transform?: (value: Item) => Item }): Transform

Type parameters

Name
Key
Value

Parameters

Name	Type
reducer	Reducer<Key, Value>
args	object
args.configuration?	Configuration
args.logger?	Logger
args.transform?	(value: Item) => Item

Returns: Transform

Defined in: src/runtime.ts:217