Interface SftpSession

A stateful SFTP session.

interface SftpSession {
    "[asyncDispose]"(): PromiseLike<void>;
    chmod(path: string, mode: number): Promise<void>;
    close(): Promise<void>;
    createReadStream(path: string): ReadableStream<Uint8Array<ArrayBufferLike>>;
    createWriteStream(
        path: string,
        opts?: SftpWriteOptions,
    ): WritableStream<Uint8Array<ArrayBufferLike>>;
    ensureDir(path: string): Promise<void>;
    exists(path: string): Promise<boolean>;
    list(path: string): Promise<SftpEntry[]>;
    mkdir(path: string): Promise<void>;
    readFile(path: string): Promise<Uint8Array<ArrayBufferLike>>;
    readJson<T = unknown>(path: string): Promise<T>;
    readText(path: string): Promise<string>;
    realpath(path: string): Promise<string>;
    remove(path: string): Promise<void>;
    removeAll(path: string, opts?: { ignoreMissing?: boolean }): Promise<void>;
    removeMany(
        paths: string[],
        opts?: { ignoreMissing?: boolean },
    ): Promise<void>;
    rename(from: string, to: string): Promise<void>;
    rmdir(path: string): Promise<void>;
    stat(path: string): Promise<SftpAttrs>;
    writeFile(
        path: string,
        data: Uint8Array,
        opts?: SftpWriteOptions,
    ): Promise<void>;
    writeJson(
        path: string,
        value: unknown,
        opts?: { space?: number },
    ): Promise<void>;
    writeText(
        path: string,
        content: string,
        opts?: SftpWriteOptions,
    ): Promise<void>;
}

Hierarchy

AsyncDisposable
- SftpSession

Methods

[asyncDispose]

"[asyncDispose]"(): PromiseLike<void>
Returns PromiseLike<void>
Inherited from AsyncDisposable.[asyncDispose]
- Defined in node_modules/typescript/lib/lib.esnext.disposable.d.ts:38

chmod

chmod(path: string, mode: number): Promise<void>
Changes a path's permission bits.
Parameters
- path: string
- mode: number
Returns Promise<void>
- Defined in src/sftp/index.ts:146

close

close(): Promise<void>
Closes the SFTP channel (and the session if this opened it).

Returns Promise<void>
- Defined in src/sftp/index.ts:148

createReadStream

createReadStream(path: string): ReadableStream<Uint8Array<ArrayBufferLike>>
Streams a file's contents.
Parameters
- path: string
Returns ReadableStream<Uint8Array<ArrayBufferLike>>
- Defined in src/sftp/index.ts:110

createWriteStream

createWriteStream(
path: string,
opts?: SftpWriteOptions,
): WritableStream<Uint8Array<ArrayBufferLike>>
Streams writes into a file (created/truncated, or appended at offset to resume).
Parameters
- path: string
- Optionalopts: SftpWriteOptions
Returns WritableStream<Uint8Array<ArrayBufferLike>>
- Defined in src/sftp/index.ts:112

ensureDir

ensureDir(path: string): Promise<void>
Creates a directory and every missing parent, like mkdir -p. SFTP MKDIR is single-level, so this issues one MKDIR per path segment and tolerates segments that already exist.
Parameters
- path: string
Returns Promise<void>
- Defined in src/sftp/index.ts:130

exists

exists(path: string): Promise<boolean>
Reports whether a path exists by attempting to stat it: a "no such file" status resolves false, success resolves true, and any other error propagates.
Parameters
- path: string
Returns Promise<boolean>
- Defined in src/sftp/index.ts:125

list

list(path: string): Promise<SftpEntry[]>
Lists a directory.
Parameters
- path: string
Returns Promise<SftpEntry[]>
- Defined in src/sftp/index.ts:98

mkdir

mkdir(path: string): Promise<void>
Creates a directory.
Parameters
- path: string
Returns Promise<void>
- Defined in src/sftp/index.ts:114

readFile

readFile(path: string): Promise<Uint8Array<ArrayBufferLike>>
Reads an entire file into memory.
Parameters
- path: string
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in src/sftp/index.ts:102

readJson

readJson<T = unknown>(path: string): Promise<T>
Reads a file, decodes it as UTF-8, and parses it as JSON.
Type Parameters
- T = unknown
Parameters
- path: string
Returns Promise<T>
- Defined in src/sftp/index.ts:136

readText

readText(path: string): Promise<string>
Reads a file and decodes it as UTF-8 text.
Parameters
- path: string
Returns Promise<string>
- Defined in src/sftp/index.ts:132

realpath

realpath(path: string): Promise<string>
Resolves a path to its canonical absolute form.
Parameters
- path: string
Returns Promise<string>
- Defined in src/sftp/index.ts:120

remove

remove(path: string): Promise<void>
Removes a file.
Parameters
- path: string
Returns Promise<void>
- Defined in src/sftp/index.ts:116

removeAll

removeAll(path: string, opts?: { ignoreMissing?: boolean }): Promise<void>
Recursively removes a directory and all of its contents (non-atomic).
Parameters
- path: string
- Optionalopts: { ignoreMissing?: boolean }
Returns Promise<void>
- Defined in src/sftp/index.ts:142

removeMany

removeMany(paths: string[], opts?: { ignoreMissing?: boolean }): Promise<void>
Removes several files.
Parameters
- paths: string[]
- Optionalopts: { ignoreMissing?: boolean }
Returns Promise<void>
- Defined in src/sftp/index.ts:144

rename

rename(from: string, to: string): Promise<void>
Renames a file or directory.
Parameters
- from: string
- to: string
Returns Promise<void>
- Defined in src/sftp/index.ts:118

rmdir

rmdir(path: string): Promise<void>
Removes an empty directory.
Parameters
- path: string
Returns Promise<void>
- Defined in src/sftp/index.ts:140

stat

stat(path: string): Promise<SftpAttrs>
Stats a path (follows symlinks).
Parameters
- path: string
Returns Promise<SftpAttrs>
- Defined in src/sftp/index.ts:100

writeFile

writeFile(
    path: string,
    data: Uint8Array,
    opts?: SftpWriteOptions,
): Promise<void>
Writes a file. With no offset the file is created/truncated; with offset the data is written at that byte position without truncating - the basis for resuming an interrupted upload (stat the partial file, then write the remainder at its size).
Parameters
- path: string
- data: Uint8Array
- Optionalopts: SftpWriteOptions
Returns Promise<void>
- Defined in src/sftp/index.ts:108

writeJson

writeJson(
    path: string,
    value: unknown,
    opts?: { space?: number },
): Promise<void>
Serializes a value as JSON and writes it to a file.
Parameters
- path: string
- value: unknown
- Optionalopts: { space?: number }
Returns Promise<void>
- Defined in src/sftp/index.ts:138

writeText

writeText(path: string, content: string, opts?: SftpWriteOptions): Promise<void>
Encodes text as UTF-8 and writes it to a file.
Parameters
- path: string
- content: string
- Optionalopts: SftpWriteOptions
Returns Promise<void>
- Defined in src/sftp/index.ts:134

Interface SftpSession

Hierarchy

Index

Methods

Methods

[asyncDispose]

Returns PromiseLike<void>

chmod

Parameters

Returns Promise<void>

close

Returns Promise<void>

createReadStream

Parameters

Returns ReadableStream<Uint8Array<ArrayBufferLike>>

createWriteStream

Parameters

Returns WritableStream<Uint8Array<ArrayBufferLike>>

ensureDir

Parameters

Returns Promise<void>

exists

Parameters

Returns Promise<boolean>

list

Parameters

Returns Promise<SftpEntry[]>

mkdir

Parameters

Returns Promise<void>

readFile

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

readJson

Type Parameters

Parameters

Returns Promise<T>

readText

Parameters

Returns Promise<string>

realpath

Parameters

Returns Promise<string>

remove

Parameters

Returns Promise<void>

removeAll

Parameters

Returns Promise<void>

removeMany

Parameters

Returns Promise<void>

rename

Parameters

Returns Promise<void>

rmdir

Parameters

Returns Promise<void>

stat

Parameters

Returns Promise<SftpAttrs>

writeFile

Parameters

Returns Promise<void>

writeJson

Parameters

Returns Promise<void>

writeText

Parameters

Returns Promise<void>

Settings

On This Page