Class DynamicCredentialCheck<L, C, P>

Source
Expand description

Checks whether the triggering user has the required Dynamic credential configured. Routes to "Ready" or "Not Ready" and returns auth URLs when the credential is missing.

Constructors§

Source§

new DynamicCredentialCheck<
    L extends string,
    C extends unknown = never,
    P extends DynamicCredentialCheckProps = never,
>(
    id: L,
    props?: P,
): DynamicCredentialCheck<L, C, P>

Properties§

§public readonly id: L

Unique identifier for this state

§public readonly label: string | undefined

The node label

§public position?: NodePosition

Position of the node in the n8n workflow editor canvas When undefined, the node will be placed automatically

default
undefined
§props?: P
§public size: NodeSizeDEFAULT_NODE_SIZE

Size of the node in the n8n workflow editor

default
DEFAULT_NODE_SIZE

Methods§

Source§

canTakeInput(
    _fromState: IChainable,
    _withConnectionOptions?: ConnectionOptions,
): boolean

Determines if this state can accept input from another state

Source§

clone<Id extends string>(
    id: Id,
    props?: NodeProps,
    cloneOptions?: { preserveChainConnections?: boolean },
): Omit<DynamicCredentialCheck<L, C, P>, "id"> & Node<
    Id,
    [P] extends [never]
        ? C
        : NonNullable<P["outputSchema"]>["infer"],
>

Creates a deep copy of this node with a new ID and optional property overrides

Source§

getCredentials(): | (Credentials<any> | undefined)[]
| undefined

Returns the credentials required by this node

Source§

getLabel(): string

Gets the display label for this node

Source§

getParameters(): Promise<{} | undefined>

Retrieves the parameters configured for this node

Source§

getPath(): string

Gets the full path of this node including its parent workflow

Source§

listOutgoing(): IChainable<string, any>[]

Returns all states that are connected as next states from this state

Source§

toNode(): Promise<
    {
        alwaysOutputData: boolean
        | undefined;
        credentials:
            | { [type: string]: { id: string } }
            | undefined;
        disabled: boolean | undefined;
        executeOnce: boolean | undefined;
        id: L;
        maxTries: number | undefined;
        name: string;
        notes: string | undefined;
        notesInFlow: boolean | undefined;
        onError:
            | "continueRegularOutput"
            | "continueErrorOutput"
            | undefined;
        parameters: {}
        | undefined;
        position: NodePosition | undefined;
        retryOnFail: boolean | undefined;
        type: string;
        typeVersion: number;
    },
>