Skip to content

plugins.md

Latest commit

 

History

History
354 lines (212 loc) · 8.08 KB

plugins.md

File metadata and controls

354 lines (212 loc) · 8.08 KB

@wholebuzz/mapreduce / Exports / plugins

Module: plugins

Table of contents

Type aliases

Variables

Functions

Type aliases

ClassFactory

Ƭ ClassFactory<X>: () => X

Type parameters

Name
X

Type declaration

+ (): X

Returns: X

Defined in: src/plugins.ts:11

Factory

Ƭ Factory<X>: ClassFactory<X> | ObjectFactory<X>

Type parameters

Name
X

Defined in: src/plugins.ts:13

ObjectFactory

Ƭ ObjectFactory<X>: () => X

Type parameters

Name
X

Type declaration

▸ (): X

Returns: X

Defined in: src/plugins.ts:12

Variables

requireFromString

• Const requireFromString: any

Defined in: src/plugins.ts:9

Functions

applyJobConfigToYargs

▸ applyJobConfigToYargs(fileSystem: FileSystem, args: Record<string, any>): Promise<Record<string, any>>

Parameters

Name Type
fileSystem FileSystem
args Record<string, any>

Returns: Promise<Record<string, any>>

Defined in: src/plugins.ts:99

deduplicateYargs

▸ deduplicateYargs(args: Record<string, any>): Record<string, any>

Parameters

Name Type
args Record<string, any>

Returns: Record<string, any>

Defined in: src/plugins.ts:118

factoryConstruct

▸ factoryConstruct<X>(factory: Factory<X>): X

Type parameters

Name
X

Parameters

Name Type
factory Factory<X>

Returns: X

Defined in: src/plugins.ts:17

getObjectClassName

▸ Const getObjectClassName(x: any): any

Parameters

Name Type
x any

Returns: any

Defined in: src/plugins.ts:15

getSubProperty

▸ getSubProperty(x: Record<string, any>, path?: string[]): any

Parameters

Name Type
x Record<string, any>
path? string[]

Returns: any

Defined in: src/plugins.ts:139

getSubPropertyAccessor

▸ getSubPropertyAccessor(path: string): function

Parameters

Name Type
path string

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

Defined in: src/plugins.ts:158

getSubPropertySetter

▸ getSubPropertySetter(path: string): function

Parameters

Name Type
path string

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

Defined in: src/plugins.ts:169

getSubPropertyWithPath

▸ getSubPropertyWithPath(x: Record<string, any>, path?: string): any

Parameters

Name Type
x Record<string, any>
path? string

Returns: any

Defined in: src/plugins.ts:135

loadConfigurationCode

▸ loadConfigurationCode(configuration: Configuration, suffix?: string): Configuration

Parameters

Name Type Default value
configuration Configuration -
suffix string 'Code'

Returns: Configuration

Defined in: src/plugins.ts:64

loadPlugin

▸ loadPlugin<X>(plugin: Record<string, any>, url: string, out?: Record<string, Factory<X>>): Record<string, Factory<X>>

Type parameters

Name
X

Parameters

Name Type Default value
plugin Record<string, any> -
url string -
out Record<string, Factory<X>> {}

Returns: Record<string, Factory<X>>

Defined in: src/plugins.ts:50

loadPluginFile

▸ loadPluginFile<X>(fileSystem: FileSystem, url: string, out?: Record<string, Factory<X>>): Promise<Record<string, Factory<X>>>

Type parameters

Name
X

Parameters

Name Type Default value
fileSystem FileSystem -
url string -
out Record<string, Factory<X>> {}

Returns: Promise<Record<string, Factory<X>>>

Defined in: src/plugins.ts:39

loadPluginFiles

▸ loadPluginFiles<X>(fileSystem: FileSystem, url: string, out?: Record<string, Factory<X>>): Promise<Record<string, Factory<X>>>

Type parameters

Name
X

Parameters

Name Type Default value
fileSystem FileSystem -
url string -
out Record<string, Factory<X>> {}

Returns: Promise<Record<string, Factory<X>>>

Defined in: src/plugins.ts:25

parseConfiguration

▸ parseConfiguration(input?: string | string[]): Record<string, any>

Parameters

Name Type
input? string | string[]

Returns: Record<string, any>

Defined in: src/plugins.ts:75

setSubProperty

▸ setSubProperty(x: Record<string, any>, path: string[], value: any): Record<string, any>

Parameters

Name Type
x Record<string, any>
path string[]
value any

Returns: Record<string, any>

Defined in: src/plugins.ts:147