Interface FtpNodeParameters

Source
interface FtpNodeParameters {
    binaryData?: boolean;
    binaryPropertyName?: string;
    fileContent?: string;
    newPath?: string;
    oldPath?: string;
    operation?:
        | "list"
        | "delete"
        | "upload"
        | "download"
        | "rename";
    options?: | {
        folder?: boolean;
        recursive?: boolean;
        timeout?: number;
    }
    | {
        chunkSize?: number;
        enableConcurrentReads?: boolean;
        maxConcurrentReads?: number;
        timeout?: number;
    }
    | { createDirectories?: boolean; timeout?: number }
    | { timeout?: number };
    path?: string;
    protocol?: "ftp" | "sftp";
    recursive?: boolean;
}

Properties§

§readonly binaryData?: boolean

The text content of the file to upload Default: true

§readonly binaryPropertyName?: string

Default: "data"

§readonly fileContent?: string

The text content of the file to upload

§readonly newPath?: string
§readonly oldPath?: string
§readonly operation?: "list" | "delete" | "upload" | "download" | "rename"

Default: "download"

§readonly options?:
    | {
        folder?: boolean;
        recursive?: boolean;
        timeout?: number;
    }
    | {
        chunkSize?: number;
        enableConcurrentReads?: boolean;
        maxConcurrentReads?: number;
        timeout?: number;
    }
    | { createDirectories?: boolean; timeout?: number }
    | { timeout?: number }

Default: {}

§readonly path?: string

The file path of the file to delete. Has to contain the full path.

§readonly protocol?: "ftp" | "sftp"

File transfer protocol Default: "ftp"

§readonly recursive?: boolean

Whether to return object representing all directories / objects recursively found within SFTP server