Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "clients/sftp"

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

SFTPBeforeUpload

SFTPBeforeUpload: function

An action that is invoked BEFORE an upload process starts.

param

The arguments.

returns

The result.

Type declaration

SFTPBeforeUploadResult

SFTPBeforeUploadResult: void | false

A possible file for an action that is invoked BEFORE an upload process starts.

SFTPCommand

SFTPCommand: SFTPCommandEntry | string

A possible value for a SFTP command.

SFTPFileMode

SFTPFileMode: number | string

A value for a file mode.

SFTPFileModePatterns

SFTPFileModePatterns: object

Patterns with file modes.

Type declaration

SFTPFileModeSettings

SFTPFileModeSettings: SFTPFileMode | SFTPFileModePatterns

A possible file mode setting value.

SFTPModeForFile

SFTPModeForFile: number | false

A mode for a file to set.

SFTPUploadCompleted

SFTPUploadCompleted: function

An action that is invoked AFTER an upload process.

param

The arguments.

returns

The result.

Type declaration

SFTPUploadCompletedResult

SFTPUploadCompletedResult: void | boolean

A possible file for an action that is invoked AFTER an upload process.

Variables

Const DEFAULT_HOST

DEFAULT_HOST: "127.0.0.1" = "127.0.0.1"

The default value for a host address.

Const SFTP

SFTP: any = require('ssh2-sftp-client')

Functions

createClient

openConnection

toSFTPPath

  • toSFTPPath(p: string): string

  • Converts to a SFTP path.

    Parameters

    • p: string

      The path to convert.

    Returns string

    The converted path.

Generated using TypeDoc