nodes

Interface CodeProps

Source


interface CodeProps {
    alwaysOutputData?: boolean;
    disabled?: boolean;
    executeOnce?: boolean;
    label?: string;
    maxTries?: number;
    notes?: string;
    notesInFlow?: boolean;
    onError?:
        | "continueRegularOutput"
        | "continueErrorOutput";
    outputSchema?: Type<unknown, {}>;
    parameters:
        | Omit<
            CodeNodeParameters,
            "language"
            | "jsCode"
            | "pythonCode",
        > & {
            jsCode: string | NodejsFunction;
            language?: "javaScript";
            pythonCode?: undefined;
        }
        | Omit<
            CodeNodeParameters,
            "language"
            | "jsCode"
            | "pythonCode",
        > & {
            jsCode?: undefined;
            language?: "pythonNative";
            pythonCode: string | PythonFunction;
        };
    position?: NodePosition;
    retryOnFail?: boolean;
}

Properties§

§alwaysOutputData?: boolean
§disabled?: boolean

If true, the node won't run but subsequent nodes WILL be executed

default
false
§executeOnce?: boolean

If active, the node executes only once, with data from the first item it receives

default
false
§label?: string
§maxTries?: number

Number of times to attempt to execute the node before failing the execution Enabled if retryOnFail is true

default
3
§notes?: string

Optional note to save with the node

default
undefined
§notesInFlow?: boolean
§onError?: "continueRegularOutput" | "continueErrorOutput"

Action to take when the node execution fails When undefined, an error will stop the workflow execution

default
undefined
§readonly outputSchema?: Type<unknown, {}>

{@inheritDoc OutputSchema}

§parameters:
    | Omit<
        CodeNodeParameters,
        "language"
        | "jsCode"
        | "pythonCode",
    > & {
        jsCode: string | NodejsFunction;
        language?: "javaScript";
        pythonCode?: undefined;
    }
    | Omit<
        CodeNodeParameters,
        "language"
        | "jsCode"
        | "pythonCode",
    > & {
        jsCode?: undefined;
        language?: "pythonNative";
        pythonCode: string | PythonFunction;
    }
§position?: NodePosition
§retryOnFail?: boolean

If active, the node tries to execute again when it fails

default
false