API リファレンス
検索インデックスを準備中…

ssh2 ベースの非同期 SFTP クライアント。ファイル操作は呼び出し順に実行します。

ソースと継承
メンバー一覧21

コンストラクター

プロパティ

メソッド

コンストラクター

プロパティ

AttributesResult: typeof SftpAttributesResult = SftpAttributesResult

属性結果型。

ソースと継承
HostKeyType: typeof SftpHostKeyType = SftpHostKeyType

サーバーホストの公開鍵型。

ソースと継承
ListingResult: typeof SftpListingResult = SftpListingResult

ディレクトリ一覧結果型。

ソースと継承
PathResult: typeof SftpPathResult = SftpPathResult

パス結果型。

ソースと継承
Result: typeof SftpResult = SftpResult

基本結果型。

ソースと継承

メソッド

  • SSH 接続を即座に破棄し、未完了の操作を起こします。

    戻り値

    void
    ソースと継承
  • SSH ハンドシェイクを確立します。既定のポートは 22 で、 その後 login で認証します。ホストの信頼性は自動検証しません。 アプリケーションはログイン前に getSessionInfo で指紋を検証できます。

    引数

    server
    port
    number = 22
    timeout
    SftpTimeout = Time.Zero

    戻り値

    Promise<SftpResult>
    ソースと継承
  • リモートディレクトリを作成します。既定の Unix 権限は 0o755 です。

    引数

    path
    string
    permissions
    number = 0o755
    timeout
    SftpTimeout = Time.Zero

    戻り値

    Promise<SftpResult>
    ソースと継承
  • リモート属性を照会します。followLinks は既定でシンボリックリンクを たどり、false ならリンク自体を照会します。

    引数

    path
    string
    followLinks
    boolean = true
    timeout
    SftpTimeout = Time.Zero

    戻り値

    ソースと継承
  • ホスト公開鍵と合意したアルゴリズムのスナップショットを返します。 ハンドシェイク情報が未準備なら undefined です。

    戻り値

    undefined | SftpSessionInfo
    ソースと継承
  • ユーザー名とパスワードで非同期に認証し、SFTP チャネルを開きます。

    引数

    name
    string
    password
    string
    timeoutオプション

    戻り値

    Promise<SftpResult>
    ソースと継承
  • 対応する公開鍵・秘密鍵と任意の秘密鍵パスフレーズで非同期に認証します。 鍵の引数はファイルパスではなく内容です。

    引数

    name
    string
    publicKey
    string | Uint8Array
    privateKey
    string | Uint8Array
    passphraseオプション
    string
    timeoutオプション

    戻り値

    Promise<SftpResult>
    ソースと継承
  • リモートパスを改名します。overwrite が true の場合は OpenSSH の上書き改名拡張へのサーバー対応が必要です。

    引数

    oldPath
    string
    newPath
    string
    overwrite
    boolean = false
    timeout
    SftpTimeout = Time.Zero

    戻り値

    Promise<SftpResult>
    ソースと継承
  • コールバックが提供するチャンクでファイルをアップロードし、 各チャンクの書き込み完了を待ちます。

    引数

    path
    string

    リモートファイルのパス。

    callback

    バッファを埋めて size を設定するコールバック。

    permissions
    number = 0o644

    新規ファイルの権限。既定は 0o644 です。

    truncate
    boolean = true

    既存ファイルを空にするか。既定は true です。

    append
    boolean = false

    追記書き込みを要求するか。既定は false です。

    offset
    bigint = 0n

    開始バイトオフセット。既定は 0n、最大値は 2^53-1 です。

    timeout
    SftpTimeout = Time.Zero

    進捗がない場合のタイムアウト設定。既定では制限なしです。

    戻り値

    Promise<SftpResult>
    ソースと継承

Icons made by Lorc, Delapouite & Skoll · game-icons.net · CC BY 3.0