@zenfs/core/dist/backends/store/fs.d.ts

A filesystem, anywhere

import { Index } from '../../internal/file_index.js';
import type { CreationOptions, UsageInfo } from '../../internal/filesystem.js';
import { FileSystem } from '../../internal/filesystem.js';
import { Inode, type InodeLike } from '../../internal/inode.js';
import { WrappedTransaction, type Store } from './store.js';
/**
 * A file system which uses a `Store`
 *
 * @todo Check modes?
 * @category Stores and Transactions
 * @internal
 */
export declare class StoreFS<T extends Store = Store> extends FileSystem {
    protected readonly store: T;
    /**
     * A map of paths to inode IDs
     * @internal @hidden
     */
    readonly _ids: Map<string, number>;
    /**
     * A map of inode IDs to paths
     * @internal @hidden
     */
    readonly _paths: Map<number, Set<string>>;
    /**
     * Gets the first path associated with an inode
     */
    _path(id: number): string | undefined;
    /**
     * Add a inode/path pair
     */
    _add(ino: number, path: string): void;
    /**
     * Remove a inode/path pair
     */
    _remove(ino: number): void;
    /**
     * Move paths in the tables
     */
    _move(from: string, to: string): void;
    protected _initialized: boolean;
    ready(): Promise<void>;
    readySync(): void;
    constructor(store: T);
    /**
     * @experimental
     */
    usage(): UsageInfo;
    /**
     * Load an index into the StoreFS.
     * You *must* manually add non-directory files
     */
    loadIndex(index: Index): Promise<void>;
    /**
     * Load an index into the StoreFS.
     * You *must* manually add non-directory files
     */
    loadIndexSync(index: Index): void;
    createIndex(): Promise<Index>;
    createIndexSync(): Index;
    /**
     * @todo Make rename compatible with the cache.
     */
    rename(oldPath: string, newPath: string): Promise<void>;
    renameSync(oldPath: string, newPath: string): void;
    stat(path: string): Promise<InodeLike>;
    statSync(path: string): InodeLike;
    touch(path: string, metadata: Partial<InodeLike>): Promise<void>;
    touchSync(path: string, metadata: Partial<InodeLike>): void;
    createFile(path: string, options: CreationOptions): Promise<InodeLike>;
    createFileSync(path: string, options: CreationOptions): InodeLike;
    unlink(path: string): Promise<void>;
    unlinkSync(path: string): void;
    rmdir(path: string): Promise<void>;
    rmdirSync(path: string): void;
    mkdir(path: string, options: CreationOptions): Promise<InodeLike>;
    mkdirSync(path: string, options: CreationOptions): InodeLike;
    readdir(path: string): Promise<string[]>;
    readdirSync(path: string): string[];
    /**
     * Updated the inode and data node at `path`
     */
    sync(): Promise<void>;
    /**
     * Updated the inode and data node at `path`
     */
    syncSync(): void;
    link(target: string, link: string): Promise<void>;
    linkSync(target: string, link: string): void;
    read(path: string, buffer: Uint8Array, offset: number, end: number): Promise<void>;
    readSync(path: string, buffer: Uint8Array, offset: number, end: number): void;
    write(path: string, data: Uint8Array, offset: number): Promise<void>;
    writeSync(path: string, data: Uint8Array, offset: number): void;
    /**
     * Wraps a transaction
     * @internal @hidden
     */
    transaction(): WrappedTransaction;
    /**
     * Checks if the root directory exists. Creates it if it doesn't.
     */
    checkRoot(): Promise<void>;
    /**
     * Checks if the root directory exists. Creates it if it doesn't.
     */
    checkRootSync(): void;
    /**
     * Populates the `_ids` and `_paths` maps with all existing files stored in the underlying `Store`.
     */
    private _populate;
    private _populateSync;
    /**
     * Find an inode without using the ID tables
     */
    private _findInode;
    /**
     * Find an inode without using the ID tables
     */
    private _findInodeSync;
    /**
     * Finds the Inode of `path`.
     * @param path The path to look up.
     * @todo memoize/cache
     */
    protected findInode(tx: WrappedTransaction, path: string): Promise<Inode>;
    /**
     * Finds the Inode of `path`.
     * @param path The path to look up.
     * @return The Inode of the path p.
     * @todo memoize/cache
     */
    protected findInodeSync(tx: WrappedTransaction, path: string): Inode;
    private _lastID?;
    /** Allocates a new ID and adds the ID/path */
    protected allocNew(path: string): number;
    /**
     * Commits a new file (well, a FILE or a DIRECTORY) to the file system with `mode`.
     * Note: This will commit the transaction.
     * @param path The path to the new file.
     * @param options The options to create the new file with.
     * @param data The data to store at the file's data node.
     */
    protected commitNew(path: string, options: CreationOptions, data: Uint8Array): Promise<Inode>;
    /**
     * Commits a new file (well, a FILE or a DIRECTORY) to the file system with `mode`.
     * Note: This will commit the transaction.
     * @param path The path to the new file.
     * @param options The options to create the new file with.
     * @param data The data to store at the file's data node.
     * @return The Inode for the new file.
     */
    protected commitNewSync(path: string, options: CreationOptions, data: Uint8Array): Inode;
    /**
     * Remove all traces of `path` from the file system.
     * @param path The path to remove from the file system.
     * @param isDir Does the path belong to a directory, or a file?
     */
    protected remove(path: string, isDir: boolean): Promise<void>;
    /**
     * Remove all traces of `path` from the file system.
     * @param path The path to remove from the file system.
     * @param isDir Does the path belong to a directory, or a file?
     */
    protected removeSync(path: string, isDir: boolean): void;
}