/**
 * @file Abstract, `node:fs/promises`-compatible file system.
 *
 * The class is a working implementation on its own: permissions, ownership and
 * timestamps are stored in an in-memory side table. Backends extend it and
 * override the `_`-prefixed protected hooks to delegate storage to a real
 * medium.
 *
 * @divergence Every protected hook receives and returns raw values. Encoding,
 * validation and metadata merging happen in the public methods.
 */
import { Dirent, Stats } from './stats.mjs';
import { FileHandle } from './handle.mjs';
export type FSDirectoryEntry = import('./stats.mjs').FSDirectoryEntry;
export type StatsModule = import('./stats.mjs').Stats;
export type FSMetadata = import('./stats.mjs').FSMetadata;
export type FSStatDescriptor = import('./stats.mjs').FSStatDescriptor;
export type FSIdentity = {
    /**
     * Effective user id.
     */
    uid: number;
    /**
     * Effective group id.
     */
    gid: number;
    /**
     * Supplementary group ids.
     */
    groups: number[];
};
export type FSOptions = {
    /**
     * Working directory used to resolve relative paths.
     */
    cwd?: string;
    /**
     * Permission mask applied on creation.
     */
    umask?: number;
    /**
     * Effective identity used by `access`.
     */
    identity?: FSIdentity;
};
export type FSCapabilities = {
    permissions: boolean;
    ownership: boolean;
    symlinks: boolean;
    timestamps: boolean;
    atomicRename: boolean;
    seekableHandles: boolean;
};
export type TReadFileOptions = {
    /**
     * When omitted or `null`, a `Uint8Array` is returned.
     */
    encoding?: string | null;
};
export type TWriteFileOptions = {
    /**
     * Encoding used to serialise string input.
     */
    encoding?: string | null;
    /**
     * When `true`, the payload is appended.
     */
    append?: boolean;
    /**
     * Permission bits applied when the file is created.
     */
    mode?: number;
};
export type TReaddirOptions = {
    /**
     * When `true`, resolves to `Dirent[]`.
     */
    withFileTypes?: boolean;
    /**
     * When `true`, walks sub-directories depth-first.
     */
    recursive?: boolean;
};
export type TMkdirOptions = {
    /**
     * When `true`, missing parents are created.
     */
    recursive?: boolean;
    /**
     * Permission bits applied to the new directory.
     */
    mode?: number;
};
export type TRmOptions = {
    /**
     * When `true`, removes directories and their contents.
     */
    recursive?: boolean;
    /**
     * When `true`, a missing path is not an error.
     */
    force?: boolean;
};
export type TStatOptions = {
    /**
     * When `false`, resolves to `undefined` instead of throwing.
     */
    throwIfNoEntry?: boolean;
};
export type TCopyFileOptions = {
    /**
     * Bitmask of `constants.COPYFILE_*` flags.
     */
    mode?: number;
};
/**
 * Abstract, `node:fs/promises`-compatible file system.
 * @beta
 */
declare class TinyFSCore {
    #private;
    /**
     * @param {FSOptions} [options] Construction options.
     */
    constructor(options?: FSOptions);
    /**
     * @returns {FSCapabilities} The capabilities advertised by the backend.
     */
    static get capabilities(): FSCapabilities;
    /** @returns {string} Working directory used to resolve relative paths. */
    get cwd(): string;
    /** @returns {number} Permission mask applied on creation. */
    get umask(): number;
    /** @returns {FSIdentity} Effective identity used by `access`. */
    get identity(): FSIdentity;
    /**
     * @protected
     * @param {string} targetPath Absolute path of the file.
     * @returns {Promise<Uint8Array>} The raw file contents.
     */
    protected _readFile(targetPath: string): Promise<Uint8Array>;
    /**
     * @protected
     * @param {string} targetPath Absolute path of the file.
     * @param {Uint8Array} bytes Payload to persist.
     * @param {TWriteFileOptions} options Write options.
     * @returns {Promise<void>} Resolves once the payload is committed.
     */
    protected _writeFile(targetPath: string, bytes: Uint8Array, options: TWriteFileOptions): Promise<void>;
    /**
     * @protected
     * @param {string} targetPath Absolute path of the directory.
     * @returns {Promise<FSDirectoryEntry[]>} The directory entries.
     */
    protected _readdir(targetPath: string): Promise<FSDirectoryEntry[]>;
    /**
     * @protected
     * @param {string} targetPath Absolute path of the directory.
     * @param {TMkdirOptions} options Creation options.
     * @returns {Promise<void>} Resolves once the directory exists.
     */
    protected _mkdir(targetPath: string, options: TMkdirOptions): Promise<void>;
    /**
     * @protected
     * @param {string} targetPath Absolute path of the entry.
     * @param {TRmOptions} options Removal options.
     * @returns {Promise<void>} Resolves once the entry is gone.
     */
    protected _rm(targetPath: string, options: TRmOptions): Promise<void>;
    /**
     * @protected
     * @param {string} targetPath Absolute path of the entry.
     * @returns {Promise<FSStatDescriptor | undefined>} The raw descriptor, or `undefined`.
     */
    protected _stat(targetPath: string): Promise<FSStatDescriptor | undefined>;
    /**
     * @protected
     * @param {string} oldPath Current absolute path.
     * @param {string} newPath Target absolute path.
     * @returns {Promise<void>} Resolves once the move is complete.
     */
    protected _rename(oldPath: string, newPath: string): Promise<void>;
    /**
     * @protected
     * @param {string} sourcePath Absolute path of the source file.
     * @param {string} destinationPath Absolute path of the destination file.
     * @param {number} mode Bitmask of `constants.COPYFILE_*` flags.
     * @returns {Promise<void>} Resolves once the copy is complete.
     */
    protected _copyFile(sourcePath: string, destinationPath: string, mode: number): Promise<void>;
    /**
     * @protected
     * @param {string} targetPath Absolute path of the entry.
     * @returns {Promise<FSMetadata>} The stored metadata.
     */
    protected _readMetadata(targetPath: string): Promise<FSMetadata>;
    /**
     * @protected
     * @param {string} targetPath Absolute path of the entry.
     * @param {FSMetadata} metadata Metadata to persist.
     * @returns {Promise<void>} Resolves once the metadata is committed.
     */
    protected _writeMetadata(targetPath: string, metadata: FSMetadata): Promise<void>;
    /**
     * Reads the entire contents of a file.
     *
     * @param {string} path Absolute path of the file.
     * @param {TReadFileOptions} [options] Read options.
     * @returns {Promise<string | Uint8Array>} The file contents.
     */
    readFile(path: string, options?: TReadFileOptions): Promise<string | Uint8Array>;
    /**
     * Writes data to a file, replacing it when it already exists.
     *
     * @param {string} path Absolute path of the file.
     * @param {string | Uint8Array | ArrayBuffer} data Payload to persist.
     * @param {TWriteFileOptions} [options] Write options.
     * @returns {Promise<void>} Resolves once the payload is committed.
     */
    writeFile(path: string, data: string | Uint8Array | ArrayBuffer, options?: TWriteFileOptions): Promise<void>;
    /**
     * Appends data to a file, creating it when missing.
     *
     * @param {string} path Absolute path of the file.
     * @param {string | Uint8Array | ArrayBuffer} data Payload to append.
     * @param {TWriteFileOptions} [options] Write options.
     * @returns {Promise<void>} Resolves once the payload is committed.
     */
    appendFile(path: string, data: string | Uint8Array | ArrayBuffer, options?: TWriteFileOptions): Promise<void>;
    /**
     * Reads the contents of a directory.
     *
     * @param {string} path Absolute path of the directory.
     * @param {TReaddirOptions} [options] Read options.
     * @returns {Promise<Array<string | Dirent>>} The entry names, or `Dirent` objects.
     */
    readdir(path: string, options?: TReaddirOptions): Promise<Array<string | Dirent>>;
    /**
     * Creates a directory.
     *
     * @param {string} path Absolute path of the directory.
     * @param {TMkdirOptions} [options] Creation options.
     * @returns {Promise<string | undefined>} The created path when `recursive` is `true`.
     */
    mkdir(path: string, options?: TMkdirOptions): Promise<string | undefined>;
    /**
     * Removes a file or, when `recursive` is `true`, a directory tree.
     *
     * @param {string} path Absolute path of the entry.
     * @param {TRmOptions} [options] Removal options.
     * @returns {Promise<void>} Resolves once the entry is gone.
     */
    rm(path: string, options?: TRmOptions): Promise<void>;
    /**
     * Removes a file.
     *
     * @param {string} path Absolute path of the file.
     * @returns {Promise<void>} Resolves once the file is gone.
     */
    unlink(path: string): Promise<void>;
    /**
     * Removes a directory.
     *
     * @param {string} path Absolute path of the directory.
     * @param {TRmOptions} [options] Removal options.
     * @returns {Promise<void>} Resolves once the directory is gone.
     */
    rmdir(path: string, options?: TRmOptions): Promise<void>;
    /**
     * Renames or moves a file or directory.
     *
     * @param {string} oldPath Current absolute path.
     * @param {string} newPath Target absolute path.
     * @returns {Promise<void>} Resolves once the move is complete.
     */
    rename(oldPath: string, newPath: string): Promise<void>;
    /**
     * Copies a file.
     *
     * @param {string} sourcePath Absolute path of the source file.
     * @param {string} destinationPath Absolute path of the destination file.
     * @param {number | TCopyFileOptions} [mode] Bitmask of `constants.COPYFILE_*` flags.
     * @returns {Promise<void>} Resolves once the copy is complete.
     */
    copyFile(sourcePath: string, destinationPath: string, mode?: number | TCopyFileOptions): Promise<void>;
    /**
     * Retrieves metadata about a file or directory.
     *
     * @param {string} path Absolute path of the entry.
     * @param {TStatOptions} [options] Stat options.
     * @returns {Promise<Stats | undefined>} The metadata snapshot.
     */
    __stat(path: string, options?: TStatOptions): Promise<Stats | undefined>;
    /**
     * Retrieves metadata about a file or directory.
     *
     * @param {string} path Absolute path of the entry.
     * @param {TStatOptions} [options] Stat options.
     * @returns {Promise<Stats>} The metadata snapshot.
     */
    stat(path: string, options?: TStatOptions): Promise<Stats>;
    /**
     * Alias of `stat`. The base class has no symbolic links.
     *
     * @param {string} path Absolute path of the entry.
     * @param {TStatOptions} [options] Stat options.
     * @returns {Promise<Stats | undefined>} The metadata snapshot.
     */
    lstat(path: string, options?: TStatOptions): Promise<Stats | undefined>;
    /**
     * Checks whether a path is reachable.
     *
     * @param {string} path Absolute path of the entry.
     * @param {number} [mode] Bitmask of `constants.F_OK`, `R_OK`, `W_OK` and `X_OK`.
     * @returns {Promise<void>} Resolves when the path is reachable.
     * @throws {Error} With `code: 'EACCES'` when the permission is missing.
     */
    access(path: string, mode?: number): Promise<void>;
    /**
     * Changes the permission bits of an entry.
     *
     * @param {string} path Absolute path of the entry.
     * @param {number} mode New permission bits.
     * @returns {Promise<void>} Resolves once the mode is committed.
     */
    chmod(path: string, mode: number): Promise<void>;
    /**
     * Changes the owner of an entry.
     *
     * @param {string} path Absolute path of the entry.
     * @param {number} uid New owner user id.
     * @param {number} [gid] New owner group id. Defaults to `uid`.
     * @returns {Promise<void>} Resolves once the ownership is committed.
     */
    chown(path: string, uid: number, gid?: number): Promise<void>;
    /**
     * Updates the access and modification times of an entry.
     *
     * @param {string} path Absolute path of the entry.
     * @param {number} atimeMs New access time in milliseconds since the epoch.
     * @param {number} [mtimeMs] New modification time. Defaults to `atimeMs`.
     * @returns {Promise<void>} Resolves once the timestamps are committed.
     */
    utimes(path: string, atimeMs: number, mtimeMs?: number): Promise<void>;
    /**
     * Truncates a file to the given length.
     *
     * @param {string} path Absolute path of the file.
     * @param {number} [length] Target length in bytes.
     * @returns {Promise<void>} Resolves once the file is truncated.
     */
    truncate(path: string, length?: number): Promise<void>;
    /**
     * Resolves the canonical absolute path.
     *
     * @param {string} path Absolute path of the entry.
     * @returns {Promise<string>} The normalised absolute path.
     */
    realpath(path: string): Promise<string>;
    /**
     * Opens a file and returns a handle.
     *
     * @param {string} path Absolute path of the file.
     * @param {string} [flags] Access mode, e.g. `'r'`, `'w'`, `'a'`.
     * @returns {Promise<FileHandle>} The opened handle.
     */
    open(path: string, flags?: string): Promise<FileHandle>;
    /**
     * Reports whether a path exists.
     *
     * @param {string} path Absolute path of the entry.
     * @returns {Promise<boolean>} `true` when the entry exists.
     */
    exists(path: string): Promise<boolean>;
}
export default TinyFSCore;
//# sourceMappingURL=index.d.mts.map