OCP App SDK

---

OCP App SDK / Runtime

Class: Runtime

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

Constructors

Constructor

new Runtime(): Runtime

Returns

Runtime

Accessors

baseDir

Get Signature

get baseDir(): string

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

Returns

string

---

manifest

Get Signature

get manifest(): Readonly<AppManifest>

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

Returns

Readonly<AppManifest>

Methods

getChannelClass()

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

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

Type Parameters

T

T extends Channel

Returns

Promise<() => T>

---

getDestinationClass()

getDestinationClass<T>(name): Promise<() => T>

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

Type Parameters

T

T extends Destination<any>

Parameters

name

string

Returns

Promise<() => T>

---

getDestinationSchema()

getDestinationSchema(): DestinationSchemaObjects

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

Returns

DestinationSchemaObjects

---

getFunctionClass()

getFunctionClass<T>(name): Promise<(request) => T>

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

Type Parameters

T

T extends Function

Parameters

name

string

Returns

Promise<(request) => T>

---

getJobClass()

getJobClass<T>(name): Promise<(invocation) => T>

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

Type Parameters

T

T extends Job

Parameters

name

string

Returns

Promise<(invocation) => T>

---

getLifecycleClass()

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

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

Type Parameters

T

T extends Lifecycle

Returns

Promise<() => T>

---

getLiquidExtensionClass()

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

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

Type Parameters

T

T extends LiquidExtension

Parameters

name

string

Returns

Promise<() => T>

---

getSchemaObjects()

getSchemaObjects(): SchemaObjects

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

Returns

SchemaObjects

---

toJson()

toJson(): string

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

Returns

string

---

fromJson()

static fromJson(serializedRuntime): Runtime

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

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

Parameters

serializedRuntime

string

JSON-serialized runtime definition

Returns

Runtime

---

initialize()

static initialize(dirName, skipJsonValidation): Promise<Runtime>

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

Initializes from a directory. Used during startup.

Parameters

dirName

string

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>