SftpAttributesResult

Result containing attributes of one filesystem entry.

Type hierarchy

Hierarchy (View Summary)

SftpResult
- SftpAttributesResult

Source & inheritance

Member directory6

Constructors

constructor

Properties

Valuestatic

Methods

getAttributes
getMessage
getValue
isOk

Constructors

constructor

new SftpAttributesResult(
result: SftpResult,
attributes?: SftpAttributes,
): SftpAttributesResult
Copy the result status and attach an attributes object.

Parameters
result
SftpResult
attributes
SftpAttributes = ...
Returns
SftpAttributesResult
Source & inheritance
Overrides SftpResult.constructor
- Defined in src/network/sftp.ts:247

Properties

`Static` `Readonly`Value

Value: typeof SftpResultValue = Value

SFTP result code enumeration.

Source & inheritance

Methods

getAttributes

getAttributes(): SftpAttributes
Return the attributes object held by this result.

Returns
SftpAttributes
Source & inheritance
- Defined in src/network/sftp.ts:257

getMessage

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

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

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