Skip to main content

@terascope/job-components / register-apis

register-apis

Functions​

getAssetPath()​

getAssetPath(assetDirs, assets, name): Promise<string>

Defined in: job-components/src/register-apis.ts:17

Parameters​

ParameterType
assetDirsstring[]
assetsstring[]
namestring

Returns​

Promise<string>


getClient()​

getClient(context, config, type): Promise<any>

Defined in: job-components/src/register-apis.ts:62

Parameters​

ParameterType
contextContext
configGetClientConfig
typestring

Returns​

Promise<any>


getOpConfig()​

getOpConfig(job, name): OpConfig | undefined

Defined in: job-components/src/register-apis.ts:12

Get the first opConfig from an operation name

Parameters​

ParameterType
jobValidatedJobConfig
namestring

Returns​

OpConfig | undefined


registerApis()​

registerApis(context, job, assetIds?): void

Defined in: job-components/src/register-apis.ts:86

Parameters​

ParameterType
contextContext
jobValidatedJobConfig | ExecutionConfig
assetIds?string[]

Returns​

void