@zenfs/core/dist/backends/backend.d.ts

A filesystem, anywhere

import type { RequiredKeys } from 'utilium';
import type { CaseFold, FileSystem } from '../internal/filesystem.js';
type OptionType = 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function' | string | ((arg: any) => boolean) | {
    [Symbol.hasInstance](instance: any): boolean;
    toString(): string;
};
/**
 * Resolves the type of Backend.options from the options interface
 * @category Backends and Configuration
 */
export type OptionsConfig<T> = {
    [K in Exclude<keyof T, keyof SharedConfig>]: {
        /**
         * The type of the option. Can be a:
         * - string given by `typeof`
         * - string that is the name of the class (e.g. `'Map'`)
         * - object with a `Symbol.hasInstance` property
         * - function that returns a boolean
         */
        type: OptionType | readonly OptionType[];
        /**
         * Whether or not the option is required (optional can be set to null or undefined). Defaults to false.
         */
        required: K extends RequiredKeys<T> ? true : false;
    };
};
/**
 * Configuration options shared by backends and `Configuration`
 * @category Backends and Configuration
 */
export interface SharedConfig {
    /**
     * If set, disables the sync cache and sync operations on async file systems.
     */
    disableAsyncCache?: boolean;
    /**
     * If set, sets case folding for the file system(s).
     */
    caseFold?: CaseFold;
}
/**
 * A backend
 * @category Backends and Configuration
 */
export interface Backend<FS extends FileSystem = FileSystem, TOptions extends object = object> {
    /**
     * Create a new instance of the backend
     */
    create(options: TOptions & Partial<SharedConfig>): FS | Promise<FS>;
    /**
     * A name to identify the backend.
     */
    name: string;
    /**
     * Describes all of the options available for this backend.
     */
    options: OptionsConfig<TOptions>;
    /**
     * 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
     *
     */
    isAvailable?(config: TOptions): boolean | Promise<boolean>;
}
/**
 * Gets the options type of a backend
 * @category Backends and Configuration
 * @internal
 */
export type OptionsOf<T extends Backend> = T extends Backend<FileSystem, infer TOptions> ? TOptions : never;
/**
 * Gets the FileSystem type for a backend
 * @category Backends and Configuration
 * @internal
 */
export type FilesystemOf<T extends Backend> = T extends Backend<infer FS> ? FS : never;
/**
 * @category Backends and Configuration
 * @internal
 */
export declare function isBackend(arg: unknown): arg is Backend;
/**
 * Use a function as the type of an option, but don't treat it as a class.
 *
 * Optionally sets the name of a function, useful for error messages.
 * @category Backends and Configuration
 * @internal
 */
export declare function _fnOpt<const T>(name: string | null | undefined, fn: (arg: T) => boolean): (arg: T) => boolean;
/**
 * Checks that `options` object is valid for the file system options.
 * @category Backends and Configuration
 * @internal
 */
export declare function checkOptions<T extends Backend>(backend: T, options: Record<string, unknown>): void;
/**
 * Specifies a file system backend type and its options.
 *
 * Individual options can recursively contain BackendConfiguration objects for values that require file systems.
 *
 * The configuration for each file system corresponds to that file system's option object passed to its `create()` method.
 *
 * @category Backends and Configuration
 */
export type BackendConfiguration<T extends Backend> = OptionsOf<T> & Partial<SharedConfig> & {
    backend: T;
};
/**
 * @internal
 * @category Backends and Configuration
 */
export declare function isBackendConfig<T extends Backend>(arg: unknown): arg is BackendConfiguration<T>;
export {};