Skip to main content

Class: abstract Session<ConfigType>

Type Parameters

Type ParameterDefault type

ConfigType

unknown

Constructors

new Session()

new Session<ConfigType>(): Session<ConfigType>

Returns

Session<ConfigType>

Properties

config?

optional config: ConfigType;

Methods

getWorkflow()

getWorkflow(): Promise<Workflow>

Returns

Promise<Workflow>


getWorkflowImpl()

abstract protected getWorkflowImpl(): Promise<Workflow>

Returns

Promise<Workflow>


run()

run(params: {
context: Context;
inputs: RawTaskIO[];
onProgress: OnProgressCallback;
}): Promise<Results>

Parameters

ParameterType

params

object

params.context

Context

params.inputs

RawTaskIO[]

params.onProgress?

OnProgressCallback

Returns

Promise<Results>


runImpl()

abstract protected runImpl(params: {
context: Context;
inputs: RawTaskIO[];
onProgress: OnProgressCallback;
}): Promise<Results>

Parameters

ParameterType

params

object

params.context

Context

params.inputs

RawTaskIO[]

params.onProgress?

OnProgressCallback

Returns

Promise<Results>


setConfig()

setConfig(config: ConfigType): void

Parameters

ParameterType

config

ConfigType

Returns

void