OCP App SDK / Runtime

Runtime

Index

Constructors

constructor

Accessors

Methods

Constructors

constructor()

Signature

new Runtime(): Runtime;

Returns

Runtime

Accessors

baseDir

Signature

baseDir(): string;

Returns

string

Defined in: src/app/Runtime.ts:57

manifest

Signature

manifest(): Readonly<AppManifest>;

Returns

Readonly<AppManifest>

Defined in: src/app/Runtime.ts:53

Methods

getChannelClass()

Signature

getChannelClass<T>(): Promise<() => T>;

Type parameters

T extends Channel<T>

Returns

Promise<() => T>

Defined in: src/app/Runtime.ts:86

getConsumerClass()

Signature

getConsumerClass<T>(name: string): Promise<() => T>;

Type parameters

T extends Consumer<JSONEncodable, T>

Parameters

Name	Type
`name`	`string`

Returns

Promise<() => T>

Defined in: src/app/Runtime.ts:72

getFunctionClass()

Signature

getFunctionClass<T>(name: string): Promise<(request: Request) => T>;

Type parameters

T extends Function<T>

Parameters

Name	Type
`name`	`string`

Returns

Promise<(request: Request) => T>

Defined in: src/app/Runtime.ts:62

getJobClass()

Signature

getJobClass<T>(name: string): Promise<(invocation: JobInvocation) => T>;

Type parameters

T extends Job<T>

Parameters

Name	Type
`name`	`string`

Returns

Promise<(invocation: JobInvocation) => T>

Defined in: src/app/Runtime.ts:90

getLifecycleClass()

Signature

getLifecycleClass<T>(): Promise<() => T>;

Type parameters

T extends Lifecycle<T>

Returns

Promise<() => T>

Defined in: src/app/Runtime.ts:82

getLiquidExtensionClass()

Signature

getLiquidExtensionClass<T>(name: string): Promise<() => T>;

Type parameters

T extends LiquidExtension<T>

Parameters

Name	Type
`name`	`string`

Returns

Promise<() => T>

Defined in: src/app/Runtime.ts:100

getSchemaObjects()

Signature

getSchemaObjects(): SchemaObjects;

Returns

SchemaObjects

Defined in: src/app/Runtime.ts:110

toJson()

Signature

toJson(): string;

Returns

string

Defined in: src/app/Runtime.ts:121

fromJson()

Initializes from a pre-validated JSON definition. Used during task execution.

Signature

Static fromJson(serializedRuntime: string): Runtime;

Parameters

Name	Type	Description
`serializedRuntime`	`string`	JSON-serialized runtime definition

Returns

Runtime

Defined in: src/app/Runtime.ts:43

initialize()

Initializes from a directory. Used during startup.

Signature

Static initialize(dirName: string, skipJsonValidation: boolean = false): Promise<Runtime>;

Parameters

Name	Type	Default value	Description
`dirName`	`string`	`undefined`	the base directory of the app
`skipJsonValidation`	`boolean`	`false`	for internal use, allows json-schema errors to be captured by the validation process

Returns

Promise<Runtime>

Defined in: src/app/Runtime.ts:33