SftpListingResult

Result containing a list of directory entry attributes.

Type hierarchy

Hierarchy (View Summary)

SftpResult
- SftpListingResult

Source & inheritance

Member directory6

Constructors

constructor

Properties

Valuestatic

Methods

getListing
getMessage
getValue
isOk

Constructors

constructor

new SftpListingResult(
result: SftpResult,
listing?: SftpAttributes[],
): SftpListingResult
Copy the result status and attach an entry list.

Parameters
result
SftpResult
listing
SftpAttributes[] = []
Returns
SftpListingResult
Source & inheritance
Overrides SftpResult.constructor
- Defined in src/network/sftp.ts:272

Properties

`Static` `Readonly`Value

Value: typeof SftpResultValue = Value

SFTP result code enumeration.

Source & inheritance

Methods

getListing

getListing(): readonly SftpAttributes[]
Return the directory entry list held by this result.

Returns
readonly SftpAttributes[]
Source & inheritance
- Defined in src/network/sftp.ts:281

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