App Runner Examples

Use these snippets to run application logic in background workers while preserving context and engine state.

App Runner Functions

import { appRunnerStart, appRunner, appRunnerEnd } from '@twin.org/dataspace-app-runner';
import type { IExecutionPayload } from '@twin.org/dataspace-models';
import type { IEngineCoreClone } from '@twin.org/engine-models';

declare const engineCloneData: IEngineCoreClone;
declare const payload: IExecutionPayload;

await appRunnerStart(engineCloneData);
const result = await appRunner(engineCloneData, payload);
console.log(result); // 1234
await appRunnerEnd();

import { appRunner } from '@twin.org/dataspace-app-runner';
import type { IExecutionPayload } from '@twin.org/dataspace-models';
import type { IEngineCoreClone } from '@twin.org/engine-models';

declare const engineCloneData: IEngineCoreClone;

const payload: IExecutionPayload = {
  executorApp: 'https://twin.example.org/app1',
  activityLogEntryId: 'urn:activity-log:001',
  activity: {
    '@context': 'https://www.w3.org/ns/activitystreams',
    type: 'Create',
    id: 'urn:activity:1'
  }
};

const result = await appRunner(engineCloneData, payload);
console.log(typeof result); // string