sftp-resolver-fs

sftp-resolver-fs

resolves sftp urls

API

Table of Contents

• SFTPScheme
  • Parameters
  • get
    • Parameters
  • name
  • defaultPort
  • isSecure
  • optionsFromEnvironment
    • Parameters

SFTPScheme

Extends URLScheme

URLScheme for sftp access

Parameters

• options Object (optional, default {})
  • options.privateKey (UInt8Array | Buffer)

get

Creates a readable stream for the content of th file associated to a given file URL

Parameters

• context Context
• url URL of the a file
• options (Object | string)? passed as options to fs.createReadStream()

Returns Promise<ReadableStream> of the file content

name

Scheme name is 'sftp'

Returns string 'sftp'

defaultPort

Returns number 22 the sftp default port

isSecure

Returns boolean true

optionsFromEnvironment

Extract options suitable for the constructor form the given set of environment variables

Parameters

• env Object

Returns Object undefined if no suitable environment variables have been found

install

With npm do:

npm install sftp-resolver-fs

license

BSD-2-Clause