SftpPathResult

Operation result containing a remote path.

Type hierarchy

Hierarchy (View Summary)

SftpResult
- SftpPathResult

Source & inheritance

Member directory6

Constructors

constructor

Properties

Valuestatic

Methods

getMessage
getPath
getValue
isOk

Constructors

constructor

new SftpPathResult(result: SftpResult, path?: string): SftpPathResult
Copy the result status and attach a path.

Parameters
result
SftpResult
path
string = ''
Returns
SftpPathResult
Source & inheritance
Overrides SftpResult.constructor
- Defined in src/network/sftp.ts:81

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
Inherited from SftpResult.getMessage
- Defined in src/network/sftp.ts:66

getPath

getPath(): string
Return the remote path; failed results usually contain an empty string.

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

getValue

getValue(): SftpResultValue
Return the result code.

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

isOk

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

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

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