Class Path

constructor

• new Path(path: string | Path): Path

• Parameters

  • path: string | Path

  Returns Path

Readonly path

basename

• basename(): undefined | string

• Returns undefined | string

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>

• 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>

existsOn

• existsOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>

findLongestExistingStemOn

• findLongestExistingStemOn(server: Server, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Path, ProcessError>

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>

getExtendedAttributesOn

• getExtendedAttributesOn(server: Server, commandOptions?: CommandOptions): ResultAsync<ExtendedAttributes, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<ExtendedAttributes, ProcessError>

getFilesystemMountOn

• getFilesystemMountOn(server: Server, commandOptions?: CommandOptions): ResultAsync<FilesystemMount, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<FilesystemMount, ProcessError>

getModeOn

• getModeOn(server: Server, commandOptions?: CommandOptions): ResultAsync<Mode, ProcessError | ParsingError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Mode, ProcessError | ParsingError>

getOwnershipOn

• getOwnershipOn(server: Server, commandOptions?: CommandOptions): ResultAsync<Ownership, ProcessError | ParsingError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Ownership, ProcessError | ParsingError>

isAbsolute

• isAbsolute(): boolean

• Returns boolean

isBlockOn

• isBlockOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>

isCharacterOn

• isCharacterOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>

isDirectoryOn

• isDirectoryOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>

isFileOn

• isFileOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>

isPipeOn

• isPipeOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>

isRelative

• isRelative(): boolean

• Returns boolean

isSocketOn

• isSocketOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>

isSymbolicLinkOn

• isSymbolicLinkOn(server: Server, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>

parent

• parent(): Path

• Returns Path

removeExtendedAttributeOn

• removeExtendedAttributeOn(server: Server, attributeName: string, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>

• Parameters

  • server: Server
  • attributeName: string
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Path, ProcessError>

resolveOn

• resolveOn(server: Server, mustExist?: boolean, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>

• Parameters

  • server: Server
  • Optional mustExist: boolean
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Path, ProcessError>

setExtendedAttributeOn

• setExtendedAttributeOn(server: Server, attributeName: string, attributeValue: string, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>

• Parameters

  • server: Server
  • attributeName: string
  • attributeValue: string
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Path, ProcessError>

setExtendedAttributesOn

• setExtendedAttributesOn(server: Server, attributes: ExtendedAttributes, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>

• Parameters

  • server: Server
  • attributes: ExtendedAttributes
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Path, ProcessError>

setModeOn

• setModeOn(server: Server, mode: number | Mode, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>

• Parameters

  • server: Server
  • mode: number | Mode
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Path, ProcessError>

setOwnershipOn

• setOwnershipOn(server: Server, ownership: Ownership, commandOptions?: CommandOptions): ResultAsync<Path, ProcessError>

• Parameters

  • server: Server
  • ownership: Ownership
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<Path, ProcessError>

testOn

• testOn(server: Server, testFlag: string, commandOptions?: CommandOptions): ResultAsync<boolean, ProcessError>

• Parameters

  • server: Server
  • testFlag: string
  • Optional commandOptions: CommandOptions

  Returns ResultAsync<boolean, ProcessError>