Interface Filesystem

Interface for filesystem functionality

interface Filesystem {
    config: FilesystemOptions<ConfigMounts>;
    constants: any;
    credentials: any;
    devfs: any;
    fs: any;
    fsSync: any;
    mounts: Map<string, any>;
    configure(options: Partial<FilesystemOptions<ConfigMounts>>): Promise<void>;
    descriptions(
        t?: TFunction<"translation", undefined> | (key: string) => string,
    ): Map<string, string>;
    exists(path: string): Promise<boolean>;
    extractTarball(tarballPath: string, extractPath: string): Promise<void>;
}

Properties

config constants credentials devfs fs fsSync mounts

Methods

configure descriptions exists extractTarball

Properties

Readonlyconfig

config: FilesystemOptions<ConfigMounts>

Get the filesystem configuration

Readonlyconstants

constants: any

Get filesystem constants

Readonlycredentials

credentials: any

Get filesystem credentials

Readonlydevfs

devfs: any

Get the device filesystem

Readonlyfs

fs: any

Get the asynchronous filesystem instance

ReadonlyfsSync

fsSync: any

Get the synchronous filesystem instance

Readonlymounts

mounts: Map<string, any>

Get mounted filesystems

Methods

configure

descriptions

  • descriptions(
        t?: TFunction<"translation", undefined> | (key: string) => string,
    ): Map<string, string>

  • Get filesystem descriptions

    Parameters

    • Optionalt: TFunction<"translation", undefined> | (key: string) => string

      Optional translation function

    Returns Map<string, string>

exists

extractTarball

  • extractTarball(tarballPath: string, extractPath: string): Promise<void>

  • Extracts a tarball to the given path.

    Parameters

    • tarballPath: string

      The path to the tarball.

    • extractPath: string

      The path to extract the tarball to.

    Returns Promise<void>

Settings

Member Visibility

On This Page

Properties
Methods