Class Filesystem`Experimental`

Author

Jay Mathis code@mathis.network (https://github.com/mathiscode)

The Filesystem class provides a virtual filesystem for the ecmaOS kernel.

See

Index

Constructors

Accessors

config constants fs fsSync

Methods

configure descriptions exists extractTarball options

Constructors

constructor

new Filesystem(): Filesystem
Experimental
Returns Filesystem

Accessors

config

get config(): Configuration<ConfigMounts>
Experimental
Returns Configuration<ConfigMounts>
The filesystem options.
- Defined in core/kernel/src/tree/filesystem.ts:62

constants

get constants(): __module
Experimental
Returns __module
Constants related to the filesystem.
- Defined in core/kernel/src/tree/filesystem.ts:67

fs

get fs(): __module
Experimental
Returns __module
The asynchronous ZenFS filesystem instance.
- Defined in core/kernel/src/tree/filesystem.ts:83

fsSync

get fsSync(): __module
Experimental
Returns __module
The synchronous ZenFS filesystem instance.
- Defined in core/kernel/src/tree/filesystem.ts:88

Methods

configure

configure(options: Partial<Configuration<ConfigMounts>>): Promise<void>
Experimental
Configures the filesystem with the given options.
Parameters
- options: Partial<Configuration<ConfigMounts>>
  The options for the filesystem.
Returns Promise<void>
A promise that resolves when the filesystem is configured.
- Defined in core/kernel/src/tree/filesystem.ts:101

descriptions

descriptions(
t?: TFunction<"translation", undefined> | (key: string) => string,
): Map<string, string>
Experimental
Parameters
- Optionalt: TFunction<"translation", undefined> | (key: string) => string
Returns Map<string, string>
- Defined in core/kernel/src/tree/filesystem.ts:193

exists

exists(path: string): Promise<boolean>
Experimental
Checks if a file or directory exists at the given path.
Parameters
- path: string
  The path to check.
Returns Promise<boolean>
A promise that resolves to true if the path exists, false otherwise.

Remarks
A shortcut for kernel.filesystem.fs.exists
- Defined in core/kernel/src/tree/filesystem.ts:130

extractTarball

extractTarball(
    tarballPath: string,
    extractPath: string,
    fileMode?: number,
    directoryMode?: number,
): Promise<void>
Experimental
Extracts a tarball to the given path.
Parameters
- tarballPath: string
  The path to the tarball.
- extractPath: string
  The path to extract the tarball to.
- fileMode: number = 0o644
  The mode to set for files. Defaults to 0o644.
- directoryMode: number = 0o755
  The mode to set for directories. Defaults to 0o755.
Returns Promise<void>
A promise that resolves when the tarball is extracted.
- Defined in core/kernel/src/tree/filesystem.ts:142

`Static`options

options<T extends ConfigMounts>(
extensions?: Partial<FilesystemOptions<T>>,
): FilesystemOptions<T>
Experimental
Returns the default filesystem options with the given extensions.
Type Parameters
- T extends ConfigMounts
Parameters
- Optionalextensions: Partial<FilesystemOptions<T>>
  The extensions to apply to the default options.
Returns FilesystemOptions<T>
The filesystem options with the given extensions.
- Defined in core/kernel/src/tree/filesystem.ts:185