Class Directory

Hierarchy-Diagram

Legend

class

public property

public method

Hierarchy (view full)

FileSystemNode
- Directory

Constructors

constructor

new Directory(node: FileSystemNode): Directory
Parameters
- node: FileSystemNode
Returns Directory
Inherited from FileSystemNode.constructor
- Defined in houston-common-lib/dist/lib/path.d.ts:71
new Directory(server: Server, path: string | Path): Directory
Parameters
- server: Server
- path: string | Path
Returns Directory
Inherited from FileSystemNode.constructor
- Defined in houston-common-lib/dist/lib/path.d.ts:72

Properties

`Readonly` path

path: string

`Readonly` server

server: Server

Methods

assertExists

assertExists(expected?: boolean, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- Optional expected: boolean
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.assertExists
- Defined in houston-common-lib/dist/lib/path.d.ts:91

assertIsDirectory

assertIsDirectory(commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.assertIsDirectory
- Defined in houston-common-lib/dist/lib/path.d.ts:93

assertIsFile

assertIsFile(commandOptions?: CommandOptions): ResultAsync<File, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<File, ProcessError>
Inherited from FileSystemNode.assertIsFile
- Defined in houston-common-lib/dist/lib/path.d.ts:92

basename

basename(): undefined | string
Returns undefined | string
Inherited from FileSystemNode.basename
- Defined in houston-common-lib/dist/lib/path.d.ts:44

create

create(parents?: boolean, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- Optional parents: boolean
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
- Defined in houston-common-lib/dist/lib/path.d.ts:130

createOn

createOn(server: Server, type: "file", parents?: boolean, commandOptions?: CommandOptions): ResultAsync<File, ProcessError>
Parameters
- server: Server
- type: "file"
- Optional parents: boolean
- Optional commandOptions: CommandOptions
Returns ResultAsync<File, ProcessError>
Inherited from FileSystemNode.createOn
- Defined in houston-common-lib/dist/lib/path.d.ts:54
createOn(server: Server, type: "directory", parents?: boolean, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- server: Server
- type: "directory"
- Optional parents: boolean
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.createOn
- Defined in houston-common-lib/dist/lib/path.d.ts:55

exists

exists(commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.exists
- Defined in houston-common-lib/dist/lib/path.d.ts:77

existsOn

existsOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.existsOn
- Defined in houston-common-lib/dist/lib/path.d.ts:49

findLongestExistingStem

findLongestExistingStem(commandOptions?: CommandOptions): ResultAsync<FileSystemNode, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<FileSystemNode, ProcessError>
Inherited from FileSystemNode.findLongestExistingStem
- Defined in houston-common-lib/dist/lib/path.d.ts:84

findLongestExistingStemOn

findLongestExistingStemOn(server: Server, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<Path, ProcessError>
Inherited from FileSystemNode.findLongestExistingStemOn
- Defined in houston-common-lib/dist/lib/path.d.ts:58

getChildren

getChildren(opts: {
    limit?: number | "none";
    nameFilter?: string;
    pathFilter?: string;
}, commandOptions?: CommandOptions): ResultAsync<FileSystemNode[], ProcessError>
Parameters
- opts: {
      limit?: number | "none";
      nameFilter?: string;
      pathFilter?: string;
  }
  - Optional limit?: number | "none"
    Limit number of returned entries. "none" for no limit. Default: 50
  - Optional nameFilter?: string
    Glob expression. Default: "*"
  - Optional pathFilter?: string
    Glob expression. Default: "*"
- Optional commandOptions: CommandOptions
Returns ResultAsync<FileSystemNode[], ProcessError>
- Defined in houston-common-lib/dist/lib/path.d.ts:132

getExtendedAttribute

getExtendedAttribute(attributeName: string, commandOptions?: CommandOptions): ResultAsync<Maybe<string>, ProcessError>
Parameters
- attributeName: string
- Optional commandOptions: CommandOptions
Returns ResultAsync<Maybe<string>, ProcessError>
Inherited from FileSystemNode.getExtendedAttribute
- Defined in houston-common-lib/dist/lib/path.d.ts:96

getExtendedAttributeOn

getExtendedAttributeOn(server: Server, attributeName: string, commandOptions?: CommandOptions): ResultAsync<Maybe<string>, ProcessError>
Parameters
- server: Server
- attributeName: string
- Optional commandOptions: CommandOptions
Returns ResultAsync<Maybe<string>, ProcessError>
Inherited from FileSystemNode.getExtendedAttributeOn
- Defined in houston-common-lib/dist/lib/path.d.ts:65

getExtendedAttributes

getExtendedAttributes(commandOptions?: CommandOptions): ResultAsync<ExtendedAttributes, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<ExtendedAttributes, ProcessError>
Inherited from FileSystemNode.getExtendedAttributes
- Defined in houston-common-lib/dist/lib/path.d.ts:94

getExtendedAttributesOn

getExtendedAttributesOn(server: Server, commandOptions?: CommandOptions): ResultAsync<ExtendedAttributes, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<ExtendedAttributes, ProcessError>
Inherited from FileSystemNode.getExtendedAttributesOn
- Defined in houston-common-lib/dist/lib/path.d.ts:63

getFilesystemMount

getFilesystemMount(commandOptions?: CommandOptions): ResultAsync<FilesystemMount, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<FilesystemMount, ProcessError>
Inherited from FileSystemNode.getFilesystemMount
- Defined in houston-common-lib/dist/lib/path.d.ts:82

getFilesystemMountOn

getFilesystemMountOn(server: Server, commandOptions?: CommandOptions): ResultAsync<FilesystemMount, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<FilesystemMount, ProcessError>
Inherited from FileSystemNode.getFilesystemMountOn
- Defined in houston-common-lib/dist/lib/path.d.ts:56

getMode

getMode(commandOptions?: CommandOptions): ResultAsync<Mode, ProcessError | ParsingError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<Mode, ProcessError | ParsingError>
Inherited from FileSystemNode.getMode
- Defined in houston-common-lib/dist/lib/path.d.ts:85

getModeOn

getModeOn(server: Server, commandOptions?: CommandOptions): ResultAsync<Mode, ProcessError | ParsingError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<Mode, ProcessError | ParsingError>
Inherited from FileSystemNode.getModeOn
- Defined in houston-common-lib/dist/lib/path.d.ts:59

getOwnership

getOwnership(commandOptions?: CommandOptions): ResultAsync<Ownership, ProcessError | ParsingError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<Ownership, ProcessError | ParsingError>
Inherited from FileSystemNode.getOwnership
- Defined in houston-common-lib/dist/lib/path.d.ts:88

getOwnershipOn

getOwnershipOn(server: Server, commandOptions?: CommandOptions): ResultAsync<Ownership, ProcessError | ParsingError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<Ownership, ProcessError | ParsingError>
Inherited from FileSystemNode.getOwnershipOn
- Defined in houston-common-lib/dist/lib/path.d.ts:61

isAbsolute

isAbsolute(): boolean
Returns boolean
Inherited from FileSystemNode.isAbsolute
- Defined in houston-common-lib/dist/lib/path.d.ts:41

isBlock

isBlock(commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isBlock
- Defined in houston-common-lib/dist/lib/path.d.ts:74

isBlockOn

isBlockOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isBlockOn
- Defined in houston-common-lib/dist/lib/path.d.ts:46

isCharacter

isCharacter(commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isCharacter
- Defined in houston-common-lib/dist/lib/path.d.ts:75

isCharacterOn

isCharacterOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isCharacterOn
- Defined in houston-common-lib/dist/lib/path.d.ts:47

isDirectory

isDirectory(commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isDirectory
- Defined in houston-common-lib/dist/lib/path.d.ts:76

isDirectoryOn

isDirectoryOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isDirectoryOn
- Defined in houston-common-lib/dist/lib/path.d.ts:48

isFile

isFile(commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isFile
- Defined in houston-common-lib/dist/lib/path.d.ts:78

isFileOn

isFileOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isFileOn
- Defined in houston-common-lib/dist/lib/path.d.ts:50

isPipe

isPipe(commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isPipe
- Defined in houston-common-lib/dist/lib/path.d.ts:80

isPipeOn

isPipeOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isPipeOn
- Defined in houston-common-lib/dist/lib/path.d.ts:52

isRelative

isRelative(): boolean
Returns boolean
Inherited from FileSystemNode.isRelative
- Defined in houston-common-lib/dist/lib/path.d.ts:42

isSocket

isSocket(commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isSocket
- Defined in houston-common-lib/dist/lib/path.d.ts:81

isSocketOn

isSocketOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isSocketOn
- Defined in houston-common-lib/dist/lib/path.d.ts:53

isSymbolicLink

isSymbolicLink(commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isSymbolicLink
- Defined in houston-common-lib/dist/lib/path.d.ts:79

isSymbolicLinkOn

isSymbolicLinkOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.isSymbolicLinkOn
- Defined in houston-common-lib/dist/lib/path.d.ts:51

move

move(...args: [newPath: string, commandOptions?: CommandOptions & {
existing?: "fail" | "clobber" | "backup";
}]): ResultAsync<Directory, ProcessError>
Parameters
- Rest ...args: [newPath: string, commandOptions?: CommandOptions & {
  existing?: "fail" | "clobber" | "backup";
  }]
Returns ResultAsync<Directory, ProcessError>
Overrides FileSystemNode.move
- Defined in houston-common-lib/dist/lib/path.d.ts:147

parent

parent(): FileSystemNode
Returns FileSystemNode
Inherited from FileSystemNode.parent
- Defined in houston-common-lib/dist/lib/path.d.ts:73

remove

remove(commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
- Defined in houston-common-lib/dist/lib/path.d.ts:131

removeExtendedAttribute

removeExtendedAttribute(attributeName: string, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- attributeName: string
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.removeExtendedAttribute
- Defined in houston-common-lib/dist/lib/path.d.ts:98

removeExtendedAttributeOn

removeExtendedAttributeOn(server: Server, attributeName: string, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- server: Server
- attributeName: string
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.removeExtendedAttributeOn
- Defined in houston-common-lib/dist/lib/path.d.ts:67

resolve

resolve(mustExist?: boolean, commandOptions?: CommandOptions): ResultAsync<FileSystemNode, ProcessError>
Parameters
- Optional mustExist: boolean
- Optional commandOptions: CommandOptions
Returns ResultAsync<FileSystemNode, ProcessError>
Inherited from FileSystemNode.resolve
- Defined in houston-common-lib/dist/lib/path.d.ts:83

resolveOn

resolveOn(server: Server, mustExist?: boolean, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>
Parameters
- server: Server
- Optional mustExist: boolean
- Optional commandOptions: CommandOptions
Returns ResultAsync<Path, ProcessError>
Inherited from FileSystemNode.resolveOn
- Defined in houston-common-lib/dist/lib/path.d.ts:57

setExtendedAttribute

setExtendedAttribute(attributeName: string, attributeValue: string, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- attributeName: string
- attributeValue: string
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setExtendedAttribute
- Defined in houston-common-lib/dist/lib/path.d.ts:97

setExtendedAttributeOn

setExtendedAttributeOn(server: Server, attributeName: string, attributeValue: string, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- server: Server
- attributeName: string
- attributeValue: string
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setExtendedAttributeOn
- Defined in houston-common-lib/dist/lib/path.d.ts:66

setExtendedAttributes

setExtendedAttributes(attributes: ExtendedAttributes, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- attributes: ExtendedAttributes
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setExtendedAttributes
- Defined in houston-common-lib/dist/lib/path.d.ts:95

setExtendedAttributesOn

setExtendedAttributesOn(server: Server, attributes: ExtendedAttributes, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- server: Server
- attributes: ExtendedAttributes
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setExtendedAttributesOn
- Defined in houston-common-lib/dist/lib/path.d.ts:64

setMode

setMode(mode: number | Mode, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- mode: number | Mode
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setMode
- Defined in houston-common-lib/dist/lib/path.d.ts:86
setMode(reference: FileSystemNode, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- reference: FileSystemNode
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setMode
- Defined in houston-common-lib/dist/lib/path.d.ts:87

setModeOn

setModeOn(server: Server, mode: number | Mode, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- server: Server
- mode: number | Mode
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setModeOn
- Defined in houston-common-lib/dist/lib/path.d.ts:60

setOwnership

setOwnership(ownership: Ownership, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- ownership: Ownership
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setOwnership
- Defined in houston-common-lib/dist/lib/path.d.ts:89
setOwnership(reference: FileSystemNode, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- reference: FileSystemNode
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setOwnership
- Defined in houston-common-lib/dist/lib/path.d.ts:90

setOwnershipOn

setOwnershipOn(server: Server, ownership: Ownership, commandOptions?: CommandOptions): ResultAsync<Directory, ProcessError>
Parameters
- server: Server
- ownership: Ownership
- Optional commandOptions: CommandOptions
Returns ResultAsync<Directory, ProcessError>
Inherited from FileSystemNode.setOwnershipOn
- Defined in houston-common-lib/dist/lib/path.d.ts:62

testOn

testOn(server: Server, testFlag: string, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>
Parameters
- server: Server
- testFlag: string
- Optional commandOptions: CommandOptions
Returns ResultAsync<boolean, ProcessError>
Inherited from FileSystemNode.testOn
- Defined in houston-common-lib/dist/lib/path.d.ts:45

Class Directory

Hierarchy-Diagram

Legend

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Directory

Parameters

Returns Directory

Properties

Readonly path

Readonly server

Methods

assertExists

Parameters

Returns ResultAsync<Directory, ProcessError>

assertIsDirectory

Parameters

Returns ResultAsync<Directory, ProcessError>

assertIsFile

Parameters

Returns ResultAsync<File, ProcessError>

basename

Returns undefined | string

create

Parameters

Returns ResultAsync<Directory, ProcessError>

createOn

Parameters

Returns ResultAsync<File, ProcessError>

Parameters

Returns ResultAsync<Directory, ProcessError>

exists

Parameters

Returns ResultAsync<boolean, ProcessError>

existsOn

Parameters

Returns ResultAsync<boolean, ProcessError>

findLongestExistingStem

Parameters

Returns ResultAsync<FileSystemNode, ProcessError>

findLongestExistingStemOn

Parameters

Returns ResultAsync<Path, ProcessError>

getChildren

Parameters

Optional limit?: number | "none"

Optional nameFilter?: string

Optional pathFilter?: string

Returns ResultAsync<FileSystemNode[], ProcessError>

getExtendedAttribute

Parameters

Returns ResultAsync<Maybe<string>, ProcessError>

getExtendedAttributeOn

Parameters

Returns ResultAsync<Maybe<string>, ProcessError>

getExtendedAttributes

Parameters

Returns ResultAsync<ExtendedAttributes, ProcessError>

getExtendedAttributesOn

Parameters

Returns ResultAsync<ExtendedAttributes, ProcessError>

getFilesystemMount

Parameters

Returns ResultAsync<FilesystemMount, ProcessError>

getFilesystemMountOn

Parameters

Returns ResultAsync<FilesystemMount, ProcessError>

getMode

Parameters

Returns ResultAsync<Mode, ProcessError | ParsingError>

getModeOn

Parameters

Returns ResultAsync<Mode, ProcessError | ParsingError>

getOwnership

`Readonly` path

`Readonly` server

`Optional` limit?: number | "none"

`Optional` nameFilter?: string

`Optional` pathFilter?: string