Skip to content

Main Navigation Guide API reference

English

English

Appearance

Sidebar Navigation

API reference

Modules

legacy

Classes

ScpClient

Interfaces

ClientEvents

ListEntry

Type Aliases

TScpOptions

Functions

Client

scp2

Classes

Client

Interfaces

Scp2Options

Scp2WriteOptions

Type Aliases

Scp2Callback

Variables

default

Functions

close

defaults

download

mkdir

parse

scp

upload

write

Classes

RemoteFs

ScpClient

ScpError

Interfaces

ConnectOptions

EntryInfo

MkdirOptions

ReadFileOptions

RemoteEntry

RemoteStats

RemoteTarget

RmOptions

ScpErrorOptions

TransferOptions

TransferProgress

TransferResult

WriteFileOptions

Type Aliases

ActiveProtocol

CopyOptions

EntryType

ErrorCode

Protocol

RemoteOs

Variables

ErrorCode

Functions

connect

download

formatTarget

isScpError

parseTarget

upload

On this page

Interface: ReadFileOptions

Options for ScpClient.readFile.

Properties

Property	Type	Description
`signal?`	`AbortSignal`	Cancels the read.

Edit this page on GitHub

Pager

Previous pageMkdirOptions

Next pageRemoteEntry

Released under the MIT License.