Class File
Hierarchy-Diagram
Legend
class
public property
public method
underlined
static property/method
Hierarchy (view full)
- FileSystemNode
- File
Index
Constructors
Properties
Methods
assert
Constructors
constructor
- new
File(node: FileSystemNode): File Parameters
- node: FileSystemNode
Returns File
- new
File(server: Server, path: string | Path): File Returns File
Properties
Readonly path
path: string
Readonly server
Methods
assert
- assert
Exists(expected?: boolean, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- expected: boolean = true
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
assert
- assert
Is Directory(commandOptions?: CommandOptions): neverthrow.ResultAsync<Directory, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<Directory, ProcessError>
assert
- assert
Is File(commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
basename
create
- create(parents?: boolean, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError>
Parameters
Optionalparents: booleanOptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
create
- create
On(server: Server, type: "file", parents?: boolean, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- server: Server
- type: "file"
Optionalparents: booleanOptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
- create
On(server: Server, type: "directory", parents?: boolean, commandOptions?: CommandOptions): neverthrow.ResultAsync<Directory, ProcessError> Parameters
- server: Server
- type: "directory"
Optionalparents: booleanOptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<Directory, ProcessError>
exists
- exists(commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError>
Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
exists
- exists
On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
find
- find
Longest Existing Stem(commandOptions?: CommandOptions): neverthrow.ResultAsync<FileSystemNode, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<FileSystemNode, ProcessError>
find
- find
Longest Existing Stem On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<Path, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<Path, ProcessError>
get
- get
Extended Attribute(attributeName: string, commandOptions?: CommandOptions): neverthrow.ResultAsync<monet.Maybe<string>, ProcessError> Parameters
- attributeName: string
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<monet.Maybe<string>, ProcessError>
get
- get
Extended Attribute On(server: Server, attributeName: string, commandOptions?: CommandOptions): neverthrow.ResultAsync<monet.Maybe<string>, ProcessError> Parameters
- server: Server
- attributeName: string
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<monet.Maybe<string>, ProcessError>
get
- get
Extended Attributes(commandOptions?: CommandOptions): neverthrow.ResultAsync<ExtendedAttributes, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<ExtendedAttributes, ProcessError>
get
- get
Extended Attributes On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<ExtendedAttributes, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<ExtendedAttributes, ProcessError>
get
- get
Filesystem Mount(commandOptions?: CommandOptions): neverthrow.ResultAsync<FilesystemMount, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<FilesystemMount, ProcessError>
get
- get
Filesystem Mount On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<FilesystemMount, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<FilesystemMount, ProcessError>
get
- get
Mode(commandOptions?: CommandOptions): neverthrow.ResultAsync<Mode, ParsingError | ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<Mode, ParsingError | ProcessError>
get
- get
Mode On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<Mode, ParsingError | ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<Mode, ParsingError | ProcessError>
get
- get
Ownership(commandOptions?: CommandOptions): neverthrow.ResultAsync<Ownership, ParsingError | ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<Ownership, ParsingError | ProcessError>
get
- get
Ownership On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<Ownership, ParsingError | ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<Ownership, ParsingError | ProcessError>
is
is
- is
Block(commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Block On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Character(commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Character On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Directory(commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Directory On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
File(commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
File On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Pipe(commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Pipe On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
is
- is
Socket(commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Socket On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Symbolic Link(commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
is
- is
Symbolic Link On(server: Server, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
move
- move(...args: [newPath: string, commandOptions: CommandOptions & {
existing?: "fail" | "clobber" | "backup";
}]): neverthrow.ResultAsync<File, ProcessError> Parameters
Rest...args: [newPath: string, commandOptions: CommandOptions & {
existing?: "fail" | "clobber" | "backup";
}]
Returns neverthrow.ResultAsync<File, ProcessError>
parent
- parent(): FileSystemNode
Returns FileSystemNode
read
- read(commandOptions?: CommandOptions & {
binary?: false;
}): neverthrow.ResultAsync<string, ProcessError> Parameters
OptionalcommandOptions: CommandOptions & {
binary?: false;
}
Returns neverthrow.ResultAsync<string, ProcessError>
- read(commandOptions: CommandOptions & {
binary: true;
}): neverthrow.ResultAsync<Uint8Array, ProcessError> Parameters
- commandOptions: CommandOptions & {
binary: true;
}
Returns neverthrow.ResultAsync<Uint8Array, ProcessError>
- commandOptions: CommandOptions & {
remove
- remove(commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError>
Parameters
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
remove
- remove
Extended Attribute(attributeName: string, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- attributeName: string
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
remove
- remove
Extended Attribute On(server: Server, attributeName: string, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- server: Server
- attributeName: string
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
replace
- replace(newContent: string | Uint8Array, commandOptions?: CommandOptions & {
backup?: boolean;
}): neverthrow.ResultAsync<File, ProcessError> Parameters
- newContent: string | Uint8Array
OptionalcommandOptions: CommandOptions & {
backup?: boolean;
}
Returns neverthrow.ResultAsync<File, ProcessError>
- replace(replacer: ((oldContent: string) => string), commandOptions?: CommandOptions & {
backup?: boolean;
binary?: false;
}): neverthrow.ResultAsync<File, ProcessError> Parameters
- replacer: ((oldContent: string) => string)
- (oldContent: string): string
Parameters
- oldContent: string
Returns string
OptionalcommandOptions: CommandOptions & {
backup?: boolean;
binary?: false;
}
Returns neverthrow.ResultAsync<File, ProcessError>
- replacer: ((oldContent: string) => string)
- replace(replacer: ((oldContent: Uint8Array) => Uint8Array), commandOptions: CommandOptions & {
backup?: boolean;
binary: true;
}): neverthrow.ResultAsync<File, ProcessError> Parameters
- replacer: ((oldContent: Uint8Array) => Uint8Array)
- (oldContent: Uint8Array): Uint8Array
Parameters
- oldContent: Uint8Array
Returns Uint8Array
- commandOptions: CommandOptions & {
backup?: boolean;
binary: true;
}
Returns neverthrow.ResultAsync<File, ProcessError>
- replacer: ((oldContent: Uint8Array) => Uint8Array)
resolve
- resolve(mustExist?: boolean, commandOptions?: CommandOptions): neverthrow.ResultAsync<FileSystemNode, ProcessError>
Parameters
- mustExist: boolean = false
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<FileSystemNode, ProcessError>
resolve
- resolve
On(server: Server, mustExist?: boolean, commandOptions?: CommandOptions): neverthrow.ResultAsync<Path, ProcessError> Parameters
- server: Server
- mustExist: boolean = false
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<Path, ProcessError>
set
- set
Extended Attribute(attributeName: string, attributeValue: string, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- attributeName: string
- attributeValue: string
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
set
- set
Extended Attribute On(server: Server, attributeName: string, attributeValue: string, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- server: Server
- attributeName: string
- attributeValue: string
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
set
- set
Extended Attributes(attributes: ExtendedAttributes, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- attributes: ExtendedAttributes
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
set
- set
Extended Attributes On(server: Server, attributes: ExtendedAttributes, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- server: Server
- attributes: ExtendedAttributes
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
set
- set
Mode(mode: number | Mode, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- mode: number | Mode
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
- set
Mode(reference: FileSystemNode, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- reference: FileSystemNode
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
set
- set
Mode On(server: Server, mode: number | Mode, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- server: Server
- mode: number | Mode
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
set
- set
Ownership(ownership: Ownership, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- ownership: Ownership
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
- set
Ownership(reference: FileSystemNode, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- reference: FileSystemNode
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
set
- set
Ownership On(server: Server, ownership: Ownership, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- server: Server
- ownership: Ownership
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>
test
- test
On(server: Server, testFlag: string, commandOptions?: CommandOptions): neverthrow.ResultAsync<boolean, ProcessError> Parameters
- server: Server
- testFlag: string
OptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<boolean, ProcessError>
write
- write(content: string | Uint8Array, commandOptions?: CommandOptions & {
append?: boolean;
}): neverthrow.ResultAsync<File, ProcessError> Parameters
- content: string | Uint8Array
- commandOptions: CommandOptions & {
append?: boolean;
} = {}
Returns neverthrow.ResultAsync<File, ProcessError>
Static make
- make
Temp(server: Server, directory?: string, commandOptions?: CommandOptions): neverthrow.ResultAsync<File, ProcessError> Parameters
- server: Server
Optionaldirectory: stringOptionalcommandOptions: CommandOptions
Returns neverthrow.ResultAsync<File, ProcessError>