import type { Abortable } from 'node:events'; import type * as fs from 'node:fs'; import type * as promises from 'node:fs/promises'; import type { Stream } from 'node:stream'; import type { ReadableStream as NodeReadableStream } from 'node:stream/web'; import type { V_Context } from '../context.js'; import type { StreamOptions } from '../internal/filesystem.js'; import type { FileContents } from '../vfs/shared.js'; import type { Interface as ReadlineInterface } from './readline.js'; import type { NodeReaddirOptions } from './types.js'; import { Buffer } from 'buffer'; import '../polyfills.js'; import type { Handle } from '../vfs/file.js'; import { Dir, Dirent } from './dir.js'; import { BigIntStats, Stats } from './stats.js'; import { ReadStream, WriteStream } from './streams.js'; export * as constants from '../constants.js'; export declare class FileHandle implements promises.FileHandle { protected context: V_Context; readonly fd: number; protected vfs: Handle; constructor(context: V_Context, fd: number); private _emitChange; /** * Asynchronous fchown(2) - Change ownership of a file. */ chown(uid: number, gid: number): Promise; /** * Asynchronous fchmod(2) - Change permissions of a file. * @param mode A file mode. If a string is passed, it is parsed as an octal integer. */ chmod(mode: fs.Mode): Promise; /** * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device. */ datasync(): Promise; /** * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device. */ sync(): Promise; /** * Asynchronous ftruncate(2) - Truncate a file to a specified length. * @param length If not specified, defaults to `0`. */ truncate(length?: number): Promise; /** * Asynchronously change file timestamps of the file. * @param atime The last access time. If a string is provided, it will be coerced to number. * @param mtime The last modified time. If a string is provided, it will be coerced to number. */ utimes(atime: fs.TimeLike, mtime: fs.TimeLike): Promise; /** * Asynchronously append data to a file, creating the file if it does not exist. The underlying file will _not_ be closed automatically. * The `FileHandle` must have been opened for appending. * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. * @param _options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. * - `encoding` defaults to `'utf8'`. * - `mode` defaults to `0o666`. * - `flag` defaults to `'a'`. */ appendFile(data: string | Uint8Array, _options?: (fs.ObjectEncodingOptions & promises.FlagAndOpenMode) | BufferEncoding): Promise; /** * Asynchronously reads data from the file. * The `FileHandle` must have been opened for reading. * @param buffer The buffer that the data will be written to. * @param offset The offset in the buffer at which to start writing. * @param length The number of bytes to read. * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position. */ read(buffer: T, offset?: number, length?: number, position?: number | null): Promise>; read(buffer: T, options?: promises.FileReadOptions): Promise>; read(options?: promises.FileReadOptions): Promise>; readFile(options?: ({ encoding?: null; } & Abortable) | null): Promise; readFile(options: ({ encoding: BufferEncoding; } & Abortable) | BufferEncoding): Promise; readFile(_options?: (fs.ObjectEncodingOptions & Abortable) | BufferEncoding | null): Promise; /** * Read file data using a `ReadableStream`. * The handle will not be closed automatically. */ readableWebStream(options?: StreamOptions): NodeReadableStream; /** * Not part of the Node.js API! * * Write file data using a `WritableStream`. * The handle will not be closed automatically. * @internal */ writableWebStream(options?: StreamOptions): WritableStream; /** * Creates a readline Interface object that allows reading the file line by line * @param options Options for creating a read stream * @returns A readline interface for reading the file line by line */ readLines(options?: promises.CreateReadStreamOptions): ReadlineInterface; [Symbol.asyncDispose](): Promise; /** * Asynchronous fstat(2) - Get file status. */ stat(opts: fs.BigIntOptions): Promise; stat(opts?: fs.StatOptions & { bigint?: false; }): Promise; /** * Asynchronously writes `string` to the file. * The `FileHandle` must have been opened for writing. * It is unsafe to call `write()` multiple times on the same file without waiting for the `Promise` * to be resolved (or rejected). For this scenario, `createWriteStream` is strongly recommended. */ write(data: T, options?: number | null | { offset?: number; length?: number; position?: number; }, lenOrEnc?: BufferEncoding | number | null, position?: number | null): Promise<{ bytesWritten: number; buffer: T; }>; /** * Asynchronously writes data to a file, replacing the file if it already exists. The underlying file will _not_ be closed automatically. * The `FileHandle` must have been opened for writing. * It is unsafe to call `writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected). * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string. * @param _options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag. * - `encoding` defaults to `'utf8'`. * - `mode` defaults to `0o666`. * - `flag` defaults to `'w'`. */ writeFile(data: string | Uint8Array, _options?: fs.WriteFileOptions): Promise; /** * Asynchronous close(2) - close a `FileHandle`. */ close(): Promise; /** * Asynchronous `writev`. Writes from multiple buffers. * @param buffers An array of Uint8Array buffers. * @param position The position in the file where to begin writing. * @returns The number of bytes written. */ writev(buffers: TBuffers, position?: number): Promise>; /** * Asynchronous `readv`. Reads into multiple buffers. * @param buffers An array of Uint8Array buffers. * @param position The position in the file where to begin reading. * @returns The number of bytes read. */ readv(buffers: TBuffers, position?: number): Promise>; /** * Creates a stream for reading from the file. * @param options Options for the readable stream */ createReadStream(options?: promises.CreateReadStreamOptions): ReadStream; /** * Creates a stream for writing to the file. * @param options Options for the writeable stream. */ createWriteStream(options?: promises.CreateWriteStreamOptions): WriteStream; } export declare function rename(this: V_Context, oldPath: fs.PathLike, newPath: fs.PathLike): Promise; /** * Test whether or not `path` exists by checking with the file system. */ export declare function exists(this: V_Context, path: fs.PathLike): Promise; export declare function stat(this: V_Context, path: fs.PathLike, options: fs.BigIntOptions): Promise; export declare function stat(this: V_Context, path: fs.PathLike, options?: { bigint?: false; }): Promise; export declare function stat(this: V_Context, path: fs.PathLike, options?: fs.StatOptions): Promise; /** * `lstat`. * `lstat()` is identical to `stat()`, except that if path is a symbolic link, * then the link itself is stat-ed, not the file that it refers to. */ export declare function lstat(this: V_Context, path: fs.PathLike, options?: { bigint?: boolean; }): Promise; export declare function lstat(this: V_Context, path: fs.PathLike, options: { bigint: true; }): Promise; export declare function truncate(this: V_Context, path: fs.PathLike, len?: number): Promise; export declare function unlink(this: V_Context, path: fs.PathLike): Promise; /** * Asynchronous file open. * @see https://nodejs.org/api/fs.html#fspromisesopenpath-flags-mode * @param flag {@link https://nodejs.org/api/fs.html#file-system-flags} * @param mode Mode to use to open the file. Can be ignored if the filesystem doesn't support permissions. */ export declare function open(this: V_Context, path: fs.PathLike, flag?: fs.OpenMode, mode?: fs.Mode): Promise; /** * Asynchronously reads the entire contents of a file. * @option encoding The string encoding for the file contents. Defaults to `null`. * @option flag Defaults to `'r'`. * @returns the file data */ export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options?: ({ encoding?: null; flag?: fs.OpenMode; } & Abortable) | null): Promise; export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options: ({ encoding: BufferEncoding; flag?: fs.OpenMode; } & Abortable) | BufferEncoding): Promise; export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, _options?: (fs.ObjectEncodingOptions & Abortable & { flag?: fs.OpenMode; }) | BufferEncoding | null): Promise; /** * Asynchronously writes data to a file, replacing the file if it already exists. * * The encoding option is ignored if data is a buffer. * @option encoding Defaults to `'utf8'`. * @option mode Defaults to `0644`. * @option flag Defaults to `'w'`. */ export declare function writeFile(this: V_Context, path: fs.PathLike | promises.FileHandle, data: FileContents | Stream | Iterable | AsyncIterable, _options?: (fs.ObjectEncodingOptions & { mode?: fs.Mode; flag?: fs.OpenMode; flush?: boolean; }) | BufferEncoding | null): Promise; /** * Asynchronously append data to a file, creating the file if it not yet exists. * @option encoding Defaults to `'utf8'`. * @option mode Defaults to `0644`. * @option flag Defaults to `'a'`. */ export declare function appendFile(this: V_Context, path: fs.PathLike | promises.FileHandle, data: FileContents, _options?: BufferEncoding | (fs.EncodingOption & { mode?: fs.Mode; flag?: fs.OpenMode; }) | null): Promise; export declare function rmdir(this: V_Context, path: fs.PathLike): Promise; /** * Asynchronous mkdir(2) - create a directory. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options Either the file mode, or an object optionally specifying the file mode and whether parent folders * should be created. If a string is passed, it is parsed as an octal integer. If not specified, defaults to `0o777`. */ export declare function mkdir(this: V_Context, path: fs.PathLike, options: fs.MakeDirectoryOptions & { recursive: true; }): Promise; export declare function mkdir(this: V_Context, path: fs.PathLike, options?: fs.Mode | (fs.MakeDirectoryOptions & { recursive?: false | undefined; }) | null): Promise; export declare function mkdir(this: V_Context, path: fs.PathLike, options?: fs.Mode | fs.MakeDirectoryOptions | null): Promise; /** * Asynchronous readdir(3) - read a directory. * * Note: The order of entries is not guaranteed * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'`. */ export declare function readdir(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & { withFileTypes?: false; recursive?: boolean; }) | BufferEncoding | null): Promise; export declare function readdir(this: V_Context, path: fs.PathLike, options: { encoding: 'buffer'; withFileTypes?: false; recursive?: boolean; } | 'buffer'): Promise; export declare function readdir(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & { withFileTypes?: false; recursive?: boolean; }) | BufferEncoding | null): Promise; export declare function readdir(this: V_Context, path: fs.PathLike, options: fs.ObjectEncodingOptions & { withFileTypes: true; recursive?: boolean; }): Promise; export declare function readdir(this: V_Context, path: fs.PathLike, options: { encoding: 'buffer'; withFileTypes: true; recursive?: boolean; }): Promise[]>; export declare function readdir(this: V_Context, path: fs.PathLike, options?: NodeReaddirOptions): Promise[] | Buffer[]>; export declare function link(this: V_Context, path: fs.PathLike, dest: fs.PathLike): Promise; /** * `symlink`. * @param dest target path * @param path link path * @param type can be either `'dir'` or `'file'` (default is `'file'`) */ export declare function symlink(this: V_Context, dest: fs.PathLike, path: fs.PathLike, type?: fs.symlink.Type | string | null): Promise; export declare function readlink(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption): Promise; export declare function readlink(this: V_Context, path: fs.PathLike, options?: fs.EncodingOption | null): Promise; export declare function readlink(this: V_Context, path: fs.PathLike, options?: fs.BufferEncodingOption | fs.EncodingOption | string | null): Promise; export declare function chown(this: V_Context, path: fs.PathLike, uid: number, gid: number): Promise; export declare function lchown(this: V_Context, path: fs.PathLike, uid: number, gid: number): Promise; export declare function chmod(this: V_Context, path: fs.PathLike, mode: fs.Mode): Promise; export declare function lchmod(this: V_Context, path: fs.PathLike, mode: fs.Mode): Promise; /** * Change file timestamps of the file referenced by the supplied path. */ export declare function utimes(this: V_Context, path: fs.PathLike, atime: fs.TimeLike, mtime: fs.TimeLike): Promise; /** * Change file timestamps of the file referenced by the supplied path. */ export declare function lutimes(this: V_Context, path: fs.PathLike, atime: fs.TimeLike, mtime: fs.TimeLike): Promise; /** * Asynchronous realpath(3) - return the canonicalized absolute pathname. * @param path A path to a file. If a URL is provided, it must use the `file:` protocol. * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. Defaults to `'utf8'`. * @todo handle options */ export declare function realpath(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption): Promise; export declare function realpath(this: V_Context, path: fs.PathLike, options?: fs.EncodingOption | BufferEncoding): Promise; export declare function watch(this: V_Context, filename: fs.PathLike, options?: fs.WatchOptions | BufferEncoding): AsyncIteratorObject, undefined>; export declare function watch(this: V_Context, filename: fs.PathLike, options: fs.WatchOptions | fs.BufferEncodingOption): AsyncIteratorObject, undefined>; export declare function watch(this: V_Context, filename: fs.PathLike, options?: fs.WatchOptions | string): AsyncIteratorObject, undefined> | AsyncIteratorObject, undefined>; export declare function access(this: V_Context, path: fs.PathLike, mode?: number): Promise; /** * Asynchronous `rm`. Removes files or directories (recursively). * @param path The path to the file or directory to remove. */ export declare function rm(this: V_Context, path: fs.PathLike, options?: fs.RmOptions): Promise; /** * Asynchronous `mkdtemp`. Creates a unique temporary directory. * @param prefix The directory prefix. * @param options The encoding (or an object including `encoding`). * @returns The path to the created temporary directory, encoded as a string or buffer. */ export declare function mkdtemp(this: V_Context, prefix: string, options?: fs.EncodingOption): Promise; export declare function mkdtemp(this: V_Context, prefix: string, options?: fs.BufferEncodingOption): Promise; /** * The resulting Promise holds an async-disposable object whose `path` property holds the created directory path. * When the object is disposed, the directory and its contents will be removed asynchronously if it still exists. * If the directory cannot be deleted, disposal will throw an error. * The object has an async `remove()` method which will perform the same task. * @todo Add `satisfies` and maybe change return type once @types/node adds this. */ export declare function mkdtempDisposable(this: V_Context, prefix: fs.PathLike, options?: fs.EncodingOption | fs.BufferEncodingOption): Promise<{ path: string; remove(): Promise; [Symbol.asyncDispose](): Promise; }>; /** * Asynchronous `copyFile`. Copies a file. * @param src The source file. * @param dest The destination file. * @param mode Optional flags for the copy operation. Currently supports these flags: * * `fs.constants.COPYFILE_EXCL`: If the destination file already exists, the operation fails. */ export declare function copyFile(this: V_Context, src: fs.PathLike, dest: fs.PathLike, mode?: number): Promise; /** * Asynchronous `opendir`. Opens a directory. * @param path The path to the directory. * @param options Options for opening the directory. * @returns A `Dir` object representing the opened directory. * @todo Use options */ export declare function opendir(this: V_Context, path: fs.PathLike, options?: fs.OpenDirOptions): Promise; /** * Asynchronous `cp`. Recursively copies a file or directory. * @param source The source file or directory. * @param destination The destination file or directory. * @param opts Options for the copy operation. Currently supports these options from Node.js 'fs.await cp': * * `dereference`: Dereference symbolic links. * * `errorOnExist`: Throw an error if the destination file or directory already exists. * * `filter`: A function that takes a source and destination path and returns a boolean, indicating whether to copy `source` element. * * `force`: Overwrite the destination if it exists, and overwrite existing readonly destination files. * * `preserveTimestamps`: Preserve file timestamps. * * `recursive`: If `true`, copies directories recursively. */ export declare function cp(this: V_Context, source: fs.PathLike, destination: fs.PathLike, opts?: fs.CopyOptions): Promise; /** * @since Node v18.15.0 * @returns Fulfills with an {fs.StatFs} for the file system. */ export declare function statfs(this: V_Context, path: fs.PathLike, opts?: fs.StatFsOptions & { bigint?: false; }): Promise; export declare function statfs(this: V_Context, path: fs.PathLike, opts: fs.StatFsOptions & { bigint: true; }): Promise; export declare function statfs(this: V_Context, path: fs.PathLike, opts?: fs.StatFsOptions): Promise; /** * Retrieves the files matching the specified pattern. */ export declare function glob(this: V_Context, pattern: string | readonly string[]): NodeJS.AsyncIterator; export declare function glob(this: V_Context, pattern: string | readonly string[], opt: fs.GlobOptionsWithFileTypes): NodeJS.AsyncIterator; export declare function glob(this: V_Context, pattern: string | readonly string[], opt: fs.GlobOptionsWithoutFileTypes): NodeJS.AsyncIterator; export declare function glob(this: V_Context, pattern: string | readonly string[], opt: fs.GlobOptions): NodeJS.AsyncIterator;