Interface Backend<FS, TOptions>

A backend

interface Backend<FS, TOptions> {
    name: string;
    options: OptionsConfig<TOptions>;
    create(options: TOptions & Partial<SharedConfig>): FS | Promise<FS>;
    isAvailable(): boolean | Promise<boolean>;
}

Type Parameters

FS extends FileSystem = FileSystem
TOptions extends object = object

Index

Properties

Methods

create isAvailable

Properties

name

name: string

A name to identify the backend.

options

options: OptionsConfig<TOptions>

Describes all of the options available for this backend.

Methods

create

create(options): FS | Promise<FS>
Create a new instance of the backend
Parameters
- options: TOptions & Partial<SharedConfig>
Returns FS | Promise<FS>
- Defined in src/backends/backend.ts:55

isAvailable

isAvailable(): boolean | Promise<boolean>
Whether the backend is available in the current environment. It supports checking synchronously and asynchronously

Returns 'true' if this backend is available in the current environment. For example, a backend using a browser API will return 'false' if the API is unavailable

Returns boolean | Promise<boolean>
- Defined in src/backends/backend.ts:76