Forest Admin - API reference
    Preparing search index...

    Type Alias WorkflowExecutorEmbedOptions

    Options for an embedded workflow executor, started in the same process as the agent through agent.addWorkflowExecutor().

    type WorkflowExecutorEmbedOptions = {
        agentUrl?: string;
        database?: { uri?: string; [option: string]: unknown };
        inMemory?: boolean;
        pollingIntervalS?: number;
        port?: number;
        stepTimeoutS?: number;
    }
    Index

    Properties

    agentUrl? database? inMemory? pollingIntervalS? port? stepTimeoutS?

    Properties

    agentUrl?: string

    URL the executor uses to reach this agent's data layer. Auto-derived when the agent runs on its own server (mountOnStandaloneServer). Required when the agent is mounted on an external framework (Express/Fastify/NestJS), since the agent cannot know the host application's address.

    database?: { uri?: string; [option: string]: unknown }

    Database connection used to persist workflow run state. Accepts a connection URI or a Sequelize options object. The agent throws at startup if it is omitted (unless inMemory is set).

    inMemory?: boolean

    Use an in-memory run store instead of a database. No database is required, but runs are lost when the process restarts, so it is not meant for production. Mutually exclusive with database.

    pollingIntervalS?: number

    Interval in seconds at which the executor polls the orchestrator for pending steps.

    port?: number

    Loopback port the embedded executor listens on; the agent proxies to it internally. Defaults to 3400.

    stepTimeoutS?: number

    Per-step execution timeout in seconds.

    Settings

    Member Visibility

    On This Page

    Properties