Runtime
OCP App SDK / Runtime
Runtime
Index
Constructors
Accessors
Methods
- getChannelClass
- getDestinationClass
- getDestinationSchema
- getFunctionClass
- getJobClass
- getLifecycleClass
- getLiquidExtensionClass
- getSchemaObjects
- toJson
- fromJson
- initialize
Constructors
constructor()
Signature
new Runtime(): Runtime;
Returns
Accessors
baseDir
Signature
baseDir(): string;
Returns
string
Defined in: src/app/Runtime.ts:57
Defined in: src/app/Runtime.ts:57
manifest
Signature
manifest(): Readonly<AppManifest>;
Returns
Readonly<AppManifest>
Defined in: src/app/Runtime.ts:53
Defined in: src/app/Runtime.ts:53
Methods
getChannelClass()
Signature
getChannelClass<T>(): Promise<() => T>;
Type parameters
TextendsChannel<T>
Returns
Promise<() => T>
Defined in: src/app/Runtime.ts:76
getDestinationClass()
Signature
getDestinationClass<T>(name: string): Promise<() => T>;
Type parameters
TextendsDestination<any,T>
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Promise<() => T>
Defined in: src/app/Runtime.ts:90
getDestinationSchema()
Signature
getDestinationSchema(): DestinationSchemaObjects;
Returns
Defined in: src/app/Runtime.ts:121
getFunctionClass()
Signature
getFunctionClass<T>(name: string): Promise<(request: Request) => T>;
Type parameters
TextendsFunction<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
TextendsJob<T>
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Promise<(invocation: JobInvocation) => T>
Defined in: src/app/Runtime.ts:80
getLifecycleClass()
Signature
getLifecycleClass<T>(): Promise<() => T>;
Type parameters
TextendsLifecycle<T>
Returns
Promise<() => T>
Defined in: src/app/Runtime.ts:72
getLiquidExtensionClass()
Signature
getLiquidExtensionClass<T>(name: string): Promise<() => T>;
Type parameters
TextendsLiquidExtension<T>
Parameters
| Name | Type |
|---|---|
name | string |
Returns
Promise<() => T>
Defined in: src/app/Runtime.ts:99
getSchemaObjects()
Signature
getSchemaObjects(): SchemaObjects;
Returns
SchemaObjects
Defined in: src/app/Runtime.ts:109
toJson()
Signature
toJson(): string;
Returns
string
Defined in: src/app/Runtime.ts:133
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
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
Updated 4 days ago