clyops Node API
    Preparing search index...

    Interface FunctionDefinition

    A configured binding to an executable, optional input/output files, artifacts, and result templates.

    interface FunctionDefinition {
        artifacts?: unknown;
        key?: string;
        positionals?: unknown[];
        positionals_order?: "first" | "last";
        result?: unknown;
        script?: string;
        stdin?: string;
        stdout?: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    artifacts? key? positionals? positionals_order? result? script? stdin? stdout?
    artifacts?: unknown

    Artifact configuration consumed by the job engine after execution.

    key?: string

    Config key holding function options; defaults to the function name.

    positionals?: unknown[]

    Explicit positional templates; an empty array explicitly supplies no positionals.

    positionals_order?: "first" | "last"

    Positionals before or after options (default: first).

    result?: unknown

    Task result or configured result templates, according to the containing interface.

    script?: string

    Executable path; configured paths are resolved against the script root.

    stdin?: string

    A template for a file fed to the tool's stdin, e.g. '${media.path}'.

    stdout?: string

    A template for the file the tool's stdout is written to; it also counts as an artifact.

    Settings
    Member Visibility

    On This Page
    Properties