nodes

Class StickyNote<L>

Source
Expand description

Make your workflow easier to understand

Constructors§

Source§

new StickyNote<L extends string>(
    id: L,
    props: StickyNoteProps,
): StickyNote<L>

Properties§

Source§

public readonly id: L

Unique identifier for this state

Source§

public readonly label: string | undefined

The node label

Source§

public position?: NodePosition

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

default
undefined
Source§

props: StickyNoteProps

Source§

public size: NodeSize = DEFAULT_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<StickyNote<L>, "id"> & Node<Id, never>

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<
    {
        color: 1
        | 3
        | 2
        | 4
        | 5
        | 6
        | 7
        | undefined;
        content?: string;
        height: number | undefined;
        width: number | 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;
    },
>