@types/ssh2-sftp-client/index.d.ts

TypeScript definitions for ssh2-sftp-client

import * as ssh2 from "ssh2";

export = sftp;

type FileInfoType = "d" | "-" | "l";

declare class sftp {
    constructor(name?: string, callbacks?: sftp.Callbacks);

    connect(options: sftp.ConnectOptions): Promise<ssh2.SFTPWrapper>;

    list(remoteFilePath: string, filter?: sftp.ListFilterFunction): Promise<sftp.FileInfo[]>;

    exists(remotePath: string): Promise<false | FileInfoType>;

    stat(remotePath: string): Promise<sftp.FileStats>;

    realPath(remotePath: string): Promise<string>;

    get(
        path: string,
        dst?: string | NodeJS.WritableStream,
        options?: sftp.TransferOptions,
    ): Promise<string | NodeJS.WritableStream | Buffer>;

    fastGet(remoteFilePath: string, localPath: string, options?: sftp.FastGetTransferOptions): Promise<string>;

    put(
        input: string | Buffer | NodeJS.ReadableStream,
        remoteFilePath: string,
        options?: sftp.TransferOptions,
    ): Promise<string>;

    fastPut(localPath: string, remoteFilePath: string, options?: sftp.FastPutTransferOptions): Promise<string>;

    cwd(): Promise<string>;

    mkdir(remoteFilePath: string, recursive?: boolean): Promise<string>;

    rmdir(remoteFilePath: string, recursive?: boolean): Promise<string>;

    delete(remoteFilePath: string, noErrorOK?: boolean): Promise<string>;

    rename(remoteSourcePath: string, remoteDestPath: string): Promise<string>;

    chmod(remotePath: string, mode: number | string): Promise<string>;

    append(
        input: Buffer | NodeJS.ReadableStream,
        remotePath: string,
        options?: sftp.WriteStreamOptions,
    ): Promise<string>;

    uploadDir(srcDir: string, destDir: string, options?: sftp.UploadDirOptions): Promise<string>;

    downloadDir(srcDir: string, destDir: string, options?: sftp.DownloadDirOptions): Promise<string>;

    end(): Promise<boolean>;

    on(event: string, callback: (...args: any[]) => void): void;

    removeListener(event: string, callback: (...args: any[]) => void): void;

    posixRename(fromPath: string, toPath: string): Promise<string>;

    rcopy(srcPath: string, dstPath: string): Promise<string>;

    createReadStream(remotePath: string, options?: ssh2.ReadStreamOptions): ssh2.ReadStream;

    createWriteStream(remotePath: string, options?: ssh2.WriteStreamOptions): ssh2.WriteStream;
}

declare namespace sftp {
    interface Callbacks {
        error?: (error: unknown) => void;
        end?: () => void;
        close?: () => void;
    }

    interface ConnectOptions extends ssh2.ConnectConfig {
        retries?: number;
        retry_factor?: number;
        retry_minTimeout?: number;
    }

    interface ModeOption {
        mode?: number | string;
    }

    interface PipeOptions {
        /**
         * @deprecated this option is ignored in v9.x. raw stream operations should use {@link createReadStream} or {@link createWriteStream} instead
         */
        end?: boolean;
    }

    interface ReadStreamOptions extends ModeOption {
        flags?: "r";
        encoding?: null | string;
        handle?: null | string;

        /**
         * @deprecated this option is ignored in v9.x. raw stream operations should use {@link createReadStream} instead
         */
        autoClose?: boolean;
    }

    interface WriteStreamOptions extends ModeOption {
        flags?: "w" | "a";
        encoding?: null | string;

        /**
         * @deprecated this option is ignored in v9.x. raw stream operations should use {@link createWriteStream} instead
         */
        autoClose?: boolean;
    }

    interface TransferOptions {
        pipeOptions?: PipeOptions;
        writeStreamOptions?: WriteStreamOptions;
        readStreamOptions?: ReadStreamOptions;
    }

    interface FastGetTransferOptions {
        concurrency?: number;
        chunkSize?: number;
        step?: (totalTransferred: number, chunk: number, total: number) => void;
    }

    interface FastPutTransferOptions extends FastGetTransferOptions, ModeOption {}

    interface FileInfo {
        type: FileInfoType;
        name: string;
        size: number;
        modifyTime: number;
        accessTime: number;
        rights: {
            user: string;
            group: string;
            other: string;
        };
        owner: number;
        group: number;
    }

    interface FileStats {
        mode: number;
        uid: number;
        gid: number;
        size: number;
        accessTime: number;
        modifyTime: number;
        isDirectory: boolean;
        isFile: boolean;
        isBlockDevice: boolean;
        isCharacterDevice: boolean;
        isSymbolicLink: boolean;
        isFIFO: boolean;
        isSocket: boolean;
    }

    type ListFilterFunction = (fileInfo: FileInfo) => boolean;
    type DirFilterFunction = (filePath: string, isDirectory: boolean) => boolean;

    interface DirOptions {
        filter?: DirFilterFunction;
    }

    interface UploadDirOptions extends DirOptions {
        useFastput?: boolean;
    }

    interface DownloadDirOptions extends DirOptions {
        useFastget?: boolean;
    }
}