Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SFTPClient

A basic SFTP client.

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _DISPOSABLES

_DISPOSABLES: vscode.Disposable[]

Stores disposable sub objects.

Protected _INTERVALS

_INTERVALS: Timer[]

Stores intervals.

Protected _TIMEOUTS

_TIMEOUTS: Timer[]

Stores timeouts.

Private _checkedRemoteDirs

_checkedRemoteDirs: object

Type declaration

  • [path: string]: boolean

client

client: any

Gets the underlying client.

isDisposed

isDisposed: boolean

Gets if object has been disposed or not.

isDisposing

isDisposing: boolean

Gets if the 'dispose()' method is currently executed or not.

isInFinalizeState

isInFinalizeState: boolean

Gets if the object is disposed or currently disposing.

options

options: SFTPConnectionOptions

values

values: Value[] = []

Stores the list of connection values.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

type

  • get type(): string

Methods

addListener

  • addListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected cleanupIntervals

  • cleanupIntervals(): void

  • Cleansup all timeouts.

    Returns void

Protected cleanupTimeouts

  • cleanupTimeouts(): void

  • Cleansup all timeouts.

    Returns void

Private createDirectoryIfNeeded

  • createDirectoryIfNeeded(dir: string): Promise<boolean>

Private createParentDirectoryIfNeeded

  • createParentDirectoryIfNeeded(dir: string): Promise<boolean>

deleteFile

  • deleteFile(path: string): Promise<boolean>

dispose

  • dispose(): void

  • Dispose this object.

    Returns void

downloadFile

  • downloadFile(path: string): Promise<Buffer>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

executeCommandsBy

  • executeCommandsBy(provider: function, additionalValues?: Value | Value[]): Promise<Buffer[]>

getMaxListeners

  • getMaxListeners(): number

  • Returns number

Protected getValuesForFile

  • getValuesForFile(file: string): Value[]

  • Returns a list of values for a file.

    Parameters

    • file: string

      The path of the remote file.

    Returns Value[]

    The values.

listDirectory

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

Protected normalizeValueName

  • normalizeValueName(name: any): string

on

  • on(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

Protected onDispose

  • onDispose(): void

once

  • once(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependListener

  • prependListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

  • Parameters

    • Optional event: string | symbol

    Returns this

removeFolder

  • removeFolder(path: string): Promise<boolean>

removeListener

  • removeListener(event: string | symbol, listener: Function): this

  • Parameters

    • event: string | symbol
    • listener: Function

    Returns this

setMaxListeners

  • setMaxListeners(n: number): this

  • Parameters

    • n: number

    Returns this

setValue

  • setValue(name: string, val: any): this

  • Sets a connection value.

    chainable

    Parameters

    • name: string

      The name of the value.

    • val: any

      The value to set.

    Returns this

    this

uploadFile

  • uploadFile(path: string, data: Buffer): Promise<void>

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc