SftpResult

SFTP operation status and message.

Type hierarchy

Hierarchy (View Summary)

SftpResult

Source & inheritance

Member directory5

Constructors

constructor

Properties

Valuestatic

Methods

getMessage
getValue
isOk

Constructors

constructor

new SftpResult(value: SftpResultValue, message?: string): SftpResult
Create a result from a result code and optional description.

Parameters
value
SftpResultValue
message
string = ''
Returns
SftpResult
Source & inheritance
- Defined in src/network/sftp.ts:45

Properties

`Static` `Readonly`Value

Value: typeof SftpResultValue = Value

SFTP result code enumeration.

Source & inheritance

Methods

getMessage

getMessage(): string
Return the error or status description.

Returns
string
Source & inheritance
- Defined in src/network/sftp.ts:66

getValue

getValue(): SftpResultValue
Return the result code.

Returns
SftpResultValue
Source & inheritance
- Defined in src/network/sftp.ts:59

isOk

isOk(): boolean
Return whether the result is Success.

Returns
boolean
Source & inheritance
- Defined in src/network/sftp.ts:52

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