|
|
@@ -0,0 +1,4658 @@
|
|
|
+declare module "node:fs" {
|
|
|
+ import { NonSharedBuffer } from "node:buffer";
|
|
|
+ import { Abortable, EventEmitter, InternalEventEmitter } from "node:events";
|
|
|
+ import { FileHandle } from "node:fs/promises";
|
|
|
+ import * as stream from "node:stream";
|
|
|
+ import { URL } from "node:url";
|
|
|
+ /**
|
|
|
+ * Valid types for path values in "fs".
|
|
|
+ */
|
|
|
+ type PathLike = string | Buffer | URL;
|
|
|
+ type PathOrFileDescriptor = PathLike | number;
|
|
|
+ type TimeLike = string | number | Date;
|
|
|
+ type NoParamCallback = (err: NodeJS.ErrnoException | null) => void;
|
|
|
+ type BufferEncodingOption =
|
|
|
+ | "buffer"
|
|
|
+ | {
|
|
|
+ encoding: "buffer";
|
|
|
+ };
|
|
|
+ interface ObjectEncodingOptions {
|
|
|
+ encoding?: BufferEncoding | null | undefined;
|
|
|
+ }
|
|
|
+ type EncodingOption = ObjectEncodingOptions | BufferEncoding | undefined | null;
|
|
|
+ type OpenMode = number | string;
|
|
|
+ type Mode = number | string;
|
|
|
+ interface StatsBase<T> {
|
|
|
+ isFile(): boolean;
|
|
|
+ isDirectory(): boolean;
|
|
|
+ isBlockDevice(): boolean;
|
|
|
+ isCharacterDevice(): boolean;
|
|
|
+ isSymbolicLink(): boolean;
|
|
|
+ isFIFO(): boolean;
|
|
|
+ isSocket(): boolean;
|
|
|
+ dev: T;
|
|
|
+ ino: T;
|
|
|
+ mode: T;
|
|
|
+ nlink: T;
|
|
|
+ uid: T;
|
|
|
+ gid: T;
|
|
|
+ rdev: T;
|
|
|
+ size: T;
|
|
|
+ blksize: T;
|
|
|
+ blocks: T;
|
|
|
+ atimeMs: T;
|
|
|
+ mtimeMs: T;
|
|
|
+ ctimeMs: T;
|
|
|
+ birthtimeMs: T;
|
|
|
+ atime: Date;
|
|
|
+ mtime: Date;
|
|
|
+ ctime: Date;
|
|
|
+ birthtime: Date;
|
|
|
+ }
|
|
|
+ interface Stats extends StatsBase<number> {}
|
|
|
+ /**
|
|
|
+ * A `fs.Stats` object provides information about a file.
|
|
|
+ *
|
|
|
+ * Objects returned from {@link stat}, {@link lstat}, {@link fstat}, and
|
|
|
+ * their synchronous counterparts are of this type.
|
|
|
+ * If `bigint` in the `options` passed to those methods is true, the numeric values
|
|
|
+ * will be `bigint` instead of `number`, and the object will contain additional
|
|
|
+ * nanosecond-precision properties suffixed with `Ns`. `Stat` objects are not to be created directly using the `new` keyword.
|
|
|
+ *
|
|
|
+ * ```console
|
|
|
+ * Stats {
|
|
|
+ * dev: 2114,
|
|
|
+ * ino: 48064969,
|
|
|
+ * mode: 33188,
|
|
|
+ * nlink: 1,
|
|
|
+ * uid: 85,
|
|
|
+ * gid: 100,
|
|
|
+ * rdev: 0,
|
|
|
+ * size: 527,
|
|
|
+ * blksize: 4096,
|
|
|
+ * blocks: 8,
|
|
|
+ * atimeMs: 1318289051000.1,
|
|
|
+ * mtimeMs: 1318289051000.1,
|
|
|
+ * ctimeMs: 1318289051000.1,
|
|
|
+ * birthtimeMs: 1318289051000.1,
|
|
|
+ * atime: Mon, 10 Oct 2011 23:24:11 GMT,
|
|
|
+ * mtime: Mon, 10 Oct 2011 23:24:11 GMT,
|
|
|
+ * ctime: Mon, 10 Oct 2011 23:24:11 GMT,
|
|
|
+ * birthtime: Mon, 10 Oct 2011 23:24:11 GMT }
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * `bigint` version:
|
|
|
+ *
|
|
|
+ * ```console
|
|
|
+ * BigIntStats {
|
|
|
+ * dev: 2114n,
|
|
|
+ * ino: 48064969n,
|
|
|
+ * mode: 33188n,
|
|
|
+ * nlink: 1n,
|
|
|
+ * uid: 85n,
|
|
|
+ * gid: 100n,
|
|
|
+ * rdev: 0n,
|
|
|
+ * size: 527n,
|
|
|
+ * blksize: 4096n,
|
|
|
+ * blocks: 8n,
|
|
|
+ * atimeMs: 1318289051000n,
|
|
|
+ * mtimeMs: 1318289051000n,
|
|
|
+ * ctimeMs: 1318289051000n,
|
|
|
+ * birthtimeMs: 1318289051000n,
|
|
|
+ * atimeNs: 1318289051000000000n,
|
|
|
+ * mtimeNs: 1318289051000000000n,
|
|
|
+ * ctimeNs: 1318289051000000000n,
|
|
|
+ * birthtimeNs: 1318289051000000000n,
|
|
|
+ * atime: Mon, 10 Oct 2011 23:24:11 GMT,
|
|
|
+ * mtime: Mon, 10 Oct 2011 23:24:11 GMT,
|
|
|
+ * ctime: Mon, 10 Oct 2011 23:24:11 GMT,
|
|
|
+ * birthtime: Mon, 10 Oct 2011 23:24:11 GMT }
|
|
|
+ * ```
|
|
|
+ * @since v0.1.21
|
|
|
+ */
|
|
|
+ class Stats {
|
|
|
+ private constructor();
|
|
|
+ }
|
|
|
+ interface StatsFsBase<T> {
|
|
|
+ /** Type of file system. */
|
|
|
+ type: T;
|
|
|
+ /** Optimal transfer block size. */
|
|
|
+ bsize: T;
|
|
|
+ /** Total data blocks in file system. */
|
|
|
+ blocks: T;
|
|
|
+ /** Free blocks in file system. */
|
|
|
+ bfree: T;
|
|
|
+ /** Available blocks for unprivileged users */
|
|
|
+ bavail: T;
|
|
|
+ /** Total file nodes in file system. */
|
|
|
+ files: T;
|
|
|
+ /** Free file nodes in file system. */
|
|
|
+ ffree: T;
|
|
|
+ }
|
|
|
+ interface StatsFs extends StatsFsBase<number> {}
|
|
|
+ /**
|
|
|
+ * Provides information about a mounted file system.
|
|
|
+ *
|
|
|
+ * Objects returned from {@link statfs} and its synchronous counterpart are of
|
|
|
+ * this type. If `bigint` in the `options` passed to those methods is `true`, the
|
|
|
+ * numeric values will be `bigint` instead of `number`.
|
|
|
+ *
|
|
|
+ * ```console
|
|
|
+ * StatFs {
|
|
|
+ * type: 1397114950,
|
|
|
+ * bsize: 4096,
|
|
|
+ * blocks: 121938943,
|
|
|
+ * bfree: 61058895,
|
|
|
+ * bavail: 61058895,
|
|
|
+ * files: 999,
|
|
|
+ * ffree: 1000000
|
|
|
+ * }
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * `bigint` version:
|
|
|
+ *
|
|
|
+ * ```console
|
|
|
+ * StatFs {
|
|
|
+ * type: 1397114950n,
|
|
|
+ * bsize: 4096n,
|
|
|
+ * blocks: 121938943n,
|
|
|
+ * bfree: 61058895n,
|
|
|
+ * bavail: 61058895n,
|
|
|
+ * files: 999n,
|
|
|
+ * ffree: 1000000n
|
|
|
+ * }
|
|
|
+ * ```
|
|
|
+ * @since v19.6.0, v18.15.0
|
|
|
+ */
|
|
|
+ class StatsFs {}
|
|
|
+ interface BigIntStatsFs extends StatsFsBase<bigint> {}
|
|
|
+ interface StatFsOptions {
|
|
|
+ bigint?: boolean | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * A representation of a directory entry, which can be a file or a subdirectory
|
|
|
+ * within the directory, as returned by reading from an `fs.Dir`. The
|
|
|
+ * directory entry is a combination of the file name and file type pairs.
|
|
|
+ *
|
|
|
+ * Additionally, when {@link readdir} or {@link readdirSync} is called with
|
|
|
+ * the `withFileTypes` option set to `true`, the resulting array is filled with `fs.Dirent` objects, rather than strings or `Buffer` s.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ class Dirent<Name extends string | Buffer = string> {
|
|
|
+ /**
|
|
|
+ * Returns `true` if the `fs.Dirent` object describes a regular file.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ isFile(): boolean;
|
|
|
+ /**
|
|
|
+ * Returns `true` if the `fs.Dirent` object describes a file system
|
|
|
+ * directory.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ isDirectory(): boolean;
|
|
|
+ /**
|
|
|
+ * Returns `true` if the `fs.Dirent` object describes a block device.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ isBlockDevice(): boolean;
|
|
|
+ /**
|
|
|
+ * Returns `true` if the `fs.Dirent` object describes a character device.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ isCharacterDevice(): boolean;
|
|
|
+ /**
|
|
|
+ * Returns `true` if the `fs.Dirent` object describes a symbolic link.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ isSymbolicLink(): boolean;
|
|
|
+ /**
|
|
|
+ * Returns `true` if the `fs.Dirent` object describes a first-in-first-out
|
|
|
+ * (FIFO) pipe.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ isFIFO(): boolean;
|
|
|
+ /**
|
|
|
+ * Returns `true` if the `fs.Dirent` object describes a socket.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ isSocket(): boolean;
|
|
|
+ /**
|
|
|
+ * The file name that this `fs.Dirent` object refers to. The type of this
|
|
|
+ * value is determined by the `options.encoding` passed to {@link readdir} or {@link readdirSync}.
|
|
|
+ * @since v10.10.0
|
|
|
+ */
|
|
|
+ name: Name;
|
|
|
+ /**
|
|
|
+ * The path to the parent directory of the file this `fs.Dirent` object refers to.
|
|
|
+ * @since v20.12.0, v18.20.0
|
|
|
+ */
|
|
|
+ parentPath: string;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * A class representing a directory stream.
|
|
|
+ *
|
|
|
+ * Created by {@link opendir}, {@link opendirSync}, or `fsPromises.opendir()`.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { opendir } from 'node:fs/promises';
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * const dir = await opendir('./');
|
|
|
+ * for await (const dirent of dir)
|
|
|
+ * console.log(dirent.name);
|
|
|
+ * } catch (err) {
|
|
|
+ * console.error(err);
|
|
|
+ * }
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * When using the async iterator, the `fs.Dir` object will be automatically
|
|
|
+ * closed after the iterator exits.
|
|
|
+ * @since v12.12.0
|
|
|
+ */
|
|
|
+ class Dir implements AsyncIterable<Dirent> {
|
|
|
+ /**
|
|
|
+ * The read-only path of this directory as was provided to {@link opendir},{@link opendirSync}, or `fsPromises.opendir()`.
|
|
|
+ * @since v12.12.0
|
|
|
+ */
|
|
|
+ readonly path: string;
|
|
|
+ /**
|
|
|
+ * Asynchronously iterates over the directory via `readdir(3)` until all entries have been read.
|
|
|
+ */
|
|
|
+ [Symbol.asyncIterator](): NodeJS.AsyncIterator<Dirent>;
|
|
|
+ /**
|
|
|
+ * Asynchronously close the directory's underlying resource handle.
|
|
|
+ * Subsequent reads will result in errors.
|
|
|
+ *
|
|
|
+ * A promise is returned that will be fulfilled after the resource has been
|
|
|
+ * closed.
|
|
|
+ * @since v12.12.0
|
|
|
+ */
|
|
|
+ close(): Promise<void>;
|
|
|
+ close(cb: NoParamCallback): void;
|
|
|
+ /**
|
|
|
+ * Synchronously close the directory's underlying resource handle.
|
|
|
+ * Subsequent reads will result in errors.
|
|
|
+ * @since v12.12.0
|
|
|
+ */
|
|
|
+ closeSync(): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously read the next directory entry via [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) as an `fs.Dirent`.
|
|
|
+ *
|
|
|
+ * A promise is returned that will be fulfilled with an `fs.Dirent`, or `null` if there are no more directory entries to read.
|
|
|
+ *
|
|
|
+ * Directory entries returned by this function are in no particular order as
|
|
|
+ * provided by the operating system's underlying directory mechanisms.
|
|
|
+ * Entries added or removed while iterating over the directory might not be
|
|
|
+ * included in the iteration results.
|
|
|
+ * @since v12.12.0
|
|
|
+ * @return containing {fs.Dirent|null}
|
|
|
+ */
|
|
|
+ read(): Promise<Dirent | null>;
|
|
|
+ read(cb: (err: NodeJS.ErrnoException | null, dirEnt: Dirent | null) => void): void;
|
|
|
+ /**
|
|
|
+ * Synchronously read the next directory entry as an `fs.Dirent`. See the
|
|
|
+ * POSIX [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) documentation for more detail.
|
|
|
+ *
|
|
|
+ * If there are no more directory entries to read, `null` will be returned.
|
|
|
+ *
|
|
|
+ * Directory entries returned by this function are in no particular order as
|
|
|
+ * provided by the operating system's underlying directory mechanisms.
|
|
|
+ * Entries added or removed while iterating over the directory might not be
|
|
|
+ * included in the iteration results.
|
|
|
+ * @since v12.12.0
|
|
|
+ */
|
|
|
+ readSync(): Dirent | null;
|
|
|
+ /**
|
|
|
+ * Calls `dir.close()` if the directory handle is open, and returns a promise that
|
|
|
+ * fulfills when disposal is complete.
|
|
|
+ * @since v24.1.0
|
|
|
+ */
|
|
|
+ [Symbol.asyncDispose](): Promise<void>;
|
|
|
+ /**
|
|
|
+ * Calls `dir.closeSync()` if the directory handle is open, and returns
|
|
|
+ * `undefined`.
|
|
|
+ * @since v24.1.0
|
|
|
+ */
|
|
|
+ [Symbol.dispose](): void;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Class: fs.StatWatcher
|
|
|
+ * @since v14.3.0, v12.20.0
|
|
|
+ * Extends `EventEmitter`
|
|
|
+ * A successful call to {@link watchFile} method will return a new fs.StatWatcher object.
|
|
|
+ */
|
|
|
+ interface StatWatcher extends EventEmitter {
|
|
|
+ /**
|
|
|
+ * When called, requests that the Node.js event loop _not_ exit so long as the `fs.StatWatcher` is active. Calling `watcher.ref()` multiple times will have
|
|
|
+ * no effect.
|
|
|
+ *
|
|
|
+ * By default, all `fs.StatWatcher` objects are "ref'ed", making it normally
|
|
|
+ * unnecessary to call `watcher.ref()` unless `watcher.unref()` had been
|
|
|
+ * called previously.
|
|
|
+ * @since v14.3.0, v12.20.0
|
|
|
+ */
|
|
|
+ ref(): this;
|
|
|
+ /**
|
|
|
+ * When called, the active `fs.StatWatcher` object will not require the Node.js
|
|
|
+ * event loop to remain active. If there is no other activity keeping the
|
|
|
+ * event loop running, the process may exit before the `fs.StatWatcher` object's
|
|
|
+ * callback is invoked. Calling `watcher.unref()` multiple times will have
|
|
|
+ * no effect.
|
|
|
+ * @since v14.3.0, v12.20.0
|
|
|
+ */
|
|
|
+ unref(): this;
|
|
|
+ }
|
|
|
+ interface FSWatcherEventMap {
|
|
|
+ "change": [eventType: string, filename: string | NonSharedBuffer];
|
|
|
+ "close": [];
|
|
|
+ "error": [error: Error];
|
|
|
+ }
|
|
|
+ interface FSWatcher extends InternalEventEmitter<FSWatcherEventMap> {
|
|
|
+ /**
|
|
|
+ * Stop watching for changes on the given `fs.FSWatcher`. Once stopped, the `fs.FSWatcher` object is no longer usable.
|
|
|
+ * @since v0.5.8
|
|
|
+ */
|
|
|
+ close(): void;
|
|
|
+ /**
|
|
|
+ * When called, requests that the Node.js event loop _not_ exit so long as the `fs.FSWatcher` is active. Calling `watcher.ref()` multiple times will have
|
|
|
+ * no effect.
|
|
|
+ *
|
|
|
+ * By default, all `fs.FSWatcher` objects are "ref'ed", making it normally
|
|
|
+ * unnecessary to call `watcher.ref()` unless `watcher.unref()` had been
|
|
|
+ * called previously.
|
|
|
+ * @since v14.3.0, v12.20.0
|
|
|
+ */
|
|
|
+ ref(): this;
|
|
|
+ /**
|
|
|
+ * When called, the active `fs.FSWatcher` object will not require the Node.js
|
|
|
+ * event loop to remain active. If there is no other activity keeping the
|
|
|
+ * event loop running, the process may exit before the `fs.FSWatcher` object's
|
|
|
+ * callback is invoked. Calling `watcher.unref()` multiple times will have
|
|
|
+ * no effect.
|
|
|
+ * @since v14.3.0, v12.20.0
|
|
|
+ */
|
|
|
+ unref(): this;
|
|
|
+ }
|
|
|
+ interface ReadStreamEventMap extends stream.ReadableEventMap {
|
|
|
+ "close": [];
|
|
|
+ "data": [chunk: string | NonSharedBuffer];
|
|
|
+ "open": [fd: number];
|
|
|
+ "ready": [];
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Instances of `fs.ReadStream` are created and returned using the {@link createReadStream} function.
|
|
|
+ * @since v0.1.93
|
|
|
+ */
|
|
|
+ class ReadStream extends stream.Readable {
|
|
|
+ close(callback?: (err?: NodeJS.ErrnoException | null) => void): void;
|
|
|
+ /**
|
|
|
+ * The number of bytes that have been read so far.
|
|
|
+ * @since v6.4.0
|
|
|
+ */
|
|
|
+ bytesRead: number;
|
|
|
+ /**
|
|
|
+ * The path to the file the stream is reading from as specified in the first
|
|
|
+ * argument to `fs.createReadStream()`. If `path` is passed as a string, then`readStream.path` will be a string. If `path` is passed as a `Buffer`, then`readStream.path` will be a
|
|
|
+ * `Buffer`. If `fd` is specified, then`readStream.path` will be `undefined`.
|
|
|
+ * @since v0.1.93
|
|
|
+ */
|
|
|
+ path: string | Buffer;
|
|
|
+ /**
|
|
|
+ * This property is `true` if the underlying file has not been opened yet,
|
|
|
+ * i.e. before the `'ready'` event is emitted.
|
|
|
+ * @since v11.2.0, v10.16.0
|
|
|
+ */
|
|
|
+ pending: boolean;
|
|
|
+ // #region InternalEventEmitter
|
|
|
+ addListener<E extends keyof ReadStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: ReadStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ addListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ emit<E extends keyof ReadStreamEventMap>(eventName: E, ...args: ReadStreamEventMap[E]): boolean;
|
|
|
+ emit(eventName: string | symbol, ...args: any[]): boolean;
|
|
|
+ listenerCount<E extends keyof ReadStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener?: (...args: ReadStreamEventMap[E]) => void,
|
|
|
+ ): number;
|
|
|
+ listenerCount(eventName: string | symbol, listener?: (...args: any[]) => void): number;
|
|
|
+ listeners<E extends keyof ReadStreamEventMap>(eventName: E): ((...args: ReadStreamEventMap[E]) => void)[];
|
|
|
+ listeners(eventName: string | symbol): ((...args: any[]) => void)[];
|
|
|
+ off<E extends keyof ReadStreamEventMap>(eventName: E, listener: (...args: ReadStreamEventMap[E]) => void): this;
|
|
|
+ off(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ on<E extends keyof ReadStreamEventMap>(eventName: E, listener: (...args: ReadStreamEventMap[E]) => void): this;
|
|
|
+ on(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ once<E extends keyof ReadStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: ReadStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ once(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ prependListener<E extends keyof ReadStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: ReadStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ prependListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ prependOnceListener<E extends keyof ReadStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: ReadStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ rawListeners<E extends keyof ReadStreamEventMap>(eventName: E): ((...args: ReadStreamEventMap[E]) => void)[];
|
|
|
+ rawListeners(eventName: string | symbol): ((...args: any[]) => void)[];
|
|
|
+ // eslint-disable-next-line @definitelytyped/no-unnecessary-generics
|
|
|
+ removeAllListeners<E extends keyof ReadStreamEventMap>(eventName?: E): this;
|
|
|
+ removeAllListeners(eventName?: string | symbol): this;
|
|
|
+ removeListener<E extends keyof ReadStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: ReadStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ removeListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ // #endregion
|
|
|
+ }
|
|
|
+ interface Utf8StreamOptions {
|
|
|
+ /**
|
|
|
+ * Appends writes to dest file instead of truncating it.
|
|
|
+ * @default true
|
|
|
+ */
|
|
|
+ append?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * Which type of data you can send to the write
|
|
|
+ * function, supported values are `'utf8'` or `'buffer'`.
|
|
|
+ * @default 'utf8'
|
|
|
+ */
|
|
|
+ contentMode?: "utf8" | "buffer" | undefined;
|
|
|
+ /**
|
|
|
+ * A path to a file to be written to (mode controlled by the
|
|
|
+ * append option).
|
|
|
+ */
|
|
|
+ dest?: string | undefined;
|
|
|
+ /**
|
|
|
+ * A file descriptor, something that is returned by `fs.open()`
|
|
|
+ * or `fs.openSync()`.
|
|
|
+ */
|
|
|
+ fd?: number | undefined;
|
|
|
+ /**
|
|
|
+ * An object that has the same API as the `fs` module, useful
|
|
|
+ * for mocking, testing, or customizing the behavior of the stream.
|
|
|
+ */
|
|
|
+ fs?: object | undefined;
|
|
|
+ /**
|
|
|
+ * Perform a `fs.fsyncSync()` every time a write is
|
|
|
+ * completed.
|
|
|
+ */
|
|
|
+ fsync?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * The maximum length of the internal buffer. If a write
|
|
|
+ * operation would cause the buffer to exceed `maxLength`, the data written is
|
|
|
+ * dropped and a drop event is emitted with the dropped data
|
|
|
+ */
|
|
|
+ maxLength?: number | undefined;
|
|
|
+ /**
|
|
|
+ * The maximum number of bytes that can be written;
|
|
|
+ * @default 16384
|
|
|
+ */
|
|
|
+ maxWrite?: number | undefined;
|
|
|
+ /**
|
|
|
+ * The minimum length of the internal buffer that is
|
|
|
+ * required to be full before flushing.
|
|
|
+ */
|
|
|
+ minLength?: number | undefined;
|
|
|
+ /**
|
|
|
+ * Ensure directory for `dest` file exists when true.
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ mkdir?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * Specify the creating file mode (see `fs.open()`).
|
|
|
+ */
|
|
|
+ mode?: number | string | undefined;
|
|
|
+ /**
|
|
|
+ * Calls flush every `periodicFlush` milliseconds.
|
|
|
+ */
|
|
|
+ periodicFlush?: number | undefined;
|
|
|
+ /**
|
|
|
+ * A function that will be called when `write()`,
|
|
|
+ * `writeSync()`, or `flushSync()` encounters an `EAGAIN` or `EBUSY` error.
|
|
|
+ * If the return value is `true` the operation will be retried, otherwise it
|
|
|
+ * will bubble the error. The `err` is the error that caused this function to
|
|
|
+ * be called, `writeBufferLen` is the length of the buffer that was written,
|
|
|
+ * and `remainingBufferLen` is the length of the remaining buffer that the
|
|
|
+ * stream did not try to write.
|
|
|
+ */
|
|
|
+ retryEAGAIN?: ((err: Error | null, writeBufferLen: number, remainingBufferLen: number) => boolean) | undefined;
|
|
|
+ /**
|
|
|
+ * Perform writes synchronously.
|
|
|
+ */
|
|
|
+ sync?: boolean | undefined;
|
|
|
+ }
|
|
|
+ interface Utf8StreamEventMap {
|
|
|
+ "close": [];
|
|
|
+ "drain": [];
|
|
|
+ "drop": [data: string | Buffer];
|
|
|
+ "error": [error: Error];
|
|
|
+ "finish": [];
|
|
|
+ "ready": [];
|
|
|
+ "write": [n: number];
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * An optimized UTF-8 stream writer that allows for flushing all the internal
|
|
|
+ * buffering on demand. It handles `EAGAIN` errors correctly, allowing for
|
|
|
+ * customization, for example, by dropping content if the disk is busy.
|
|
|
+ * @since v24.6.0
|
|
|
+ * @experimental
|
|
|
+ */
|
|
|
+ class Utf8Stream implements EventEmitter {
|
|
|
+ constructor(options: Utf8StreamOptions);
|
|
|
+ /**
|
|
|
+ * Whether the stream is appending to the file or truncating it.
|
|
|
+ */
|
|
|
+ readonly append: boolean;
|
|
|
+ /**
|
|
|
+ * The type of data that can be written to the stream. Supported
|
|
|
+ * values are `'utf8'` or `'buffer'`.
|
|
|
+ * @default 'utf8'
|
|
|
+ */
|
|
|
+ readonly contentMode: "utf8" | "buffer";
|
|
|
+ /**
|
|
|
+ * Close the stream immediately, without flushing the internal buffer.
|
|
|
+ */
|
|
|
+ destroy(): void;
|
|
|
+ /**
|
|
|
+ * Close the stream gracefully, flushing the internal buffer before closing.
|
|
|
+ */
|
|
|
+ end(): void;
|
|
|
+ /**
|
|
|
+ * The file descriptor that is being written to.
|
|
|
+ */
|
|
|
+ readonly fd: number;
|
|
|
+ /**
|
|
|
+ * The file that is being written to.
|
|
|
+ */
|
|
|
+ readonly file: string;
|
|
|
+ /**
|
|
|
+ * Writes the current buffer to the file if a write was not in progress. Do
|
|
|
+ * nothing if `minLength` is zero or if it is already writing.
|
|
|
+ */
|
|
|
+ flush(callback: (err: Error | null) => void): void;
|
|
|
+ /**
|
|
|
+ * Flushes the buffered data synchronously. This is a costly operation.
|
|
|
+ */
|
|
|
+ flushSync(): void;
|
|
|
+ /**
|
|
|
+ * Whether the stream is performing a `fs.fsyncSync()` after every
|
|
|
+ * write operation.
|
|
|
+ */
|
|
|
+ readonly fsync: boolean;
|
|
|
+ /**
|
|
|
+ * The maximum length of the internal buffer. If a write
|
|
|
+ * operation would cause the buffer to exceed `maxLength`, the data written is
|
|
|
+ * dropped and a drop event is emitted with the dropped data.
|
|
|
+ */
|
|
|
+ readonly maxLength: number;
|
|
|
+ /**
|
|
|
+ * The minimum length of the internal buffer that is required to be
|
|
|
+ * full before flushing.
|
|
|
+ */
|
|
|
+ readonly minLength: number;
|
|
|
+ /**
|
|
|
+ * Whether the stream should ensure that the directory for the
|
|
|
+ * `dest` file exists. If `true`, it will create the directory if it does not
|
|
|
+ * exist.
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ readonly mkdir: boolean;
|
|
|
+ /**
|
|
|
+ * The mode of the file that is being written to.
|
|
|
+ */
|
|
|
+ readonly mode: number | string;
|
|
|
+ /**
|
|
|
+ * The number of milliseconds between flushes. If set to `0`, no
|
|
|
+ * periodic flushes will be performed.
|
|
|
+ */
|
|
|
+ readonly periodicFlush: number;
|
|
|
+ /**
|
|
|
+ * Reopen the file in place, useful for log rotation.
|
|
|
+ * @param file A path to a file to be written to (mode
|
|
|
+ * controlled by the append option).
|
|
|
+ */
|
|
|
+ reopen(file: PathLike): void;
|
|
|
+ /**
|
|
|
+ * Whether the stream is writing synchronously or asynchronously.
|
|
|
+ */
|
|
|
+ readonly sync: boolean;
|
|
|
+ /**
|
|
|
+ * When the `options.contentMode` is set to `'utf8'` when the stream is created,
|
|
|
+ * the `data` argument must be a string. If the `contentMode` is set to `'buffer'`,
|
|
|
+ * the `data` argument must be a `Buffer`.
|
|
|
+ * @param data The data to write.
|
|
|
+ */
|
|
|
+ write(data: string | Buffer): boolean;
|
|
|
+ /**
|
|
|
+ * Whether the stream is currently writing data to the file.
|
|
|
+ */
|
|
|
+ readonly writing: boolean;
|
|
|
+ /**
|
|
|
+ * Calls `utf8Stream.destroy()`.
|
|
|
+ */
|
|
|
+ [Symbol.dispose](): void;
|
|
|
+ }
|
|
|
+ interface Utf8Stream extends InternalEventEmitter<Utf8StreamEventMap> {}
|
|
|
+ interface WriteStreamEventMap extends stream.WritableEventMap {
|
|
|
+ "close": [];
|
|
|
+ "open": [fd: number];
|
|
|
+ "ready": [];
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Instances of `fs.WriteStream` are created and returned using the {@link createWriteStream} function.
|
|
|
+ * @since v0.1.93
|
|
|
+ */
|
|
|
+ class WriteStream extends stream.Writable {
|
|
|
+ /**
|
|
|
+ * Closes `writeStream`. Optionally accepts a
|
|
|
+ * callback that will be executed once the `writeStream`is closed.
|
|
|
+ * @since v0.9.4
|
|
|
+ */
|
|
|
+ close(callback?: (err?: NodeJS.ErrnoException | null) => void): void;
|
|
|
+ /**
|
|
|
+ * The number of bytes written so far. Does not include data that is still queued
|
|
|
+ * for writing.
|
|
|
+ * @since v0.4.7
|
|
|
+ */
|
|
|
+ bytesWritten: number;
|
|
|
+ /**
|
|
|
+ * The path to the file the stream is writing to as specified in the first
|
|
|
+ * argument to {@link createWriteStream}. If `path` is passed as a string, then`writeStream.path` will be a string. If `path` is passed as a `Buffer`, then`writeStream.path` will be a
|
|
|
+ * `Buffer`.
|
|
|
+ * @since v0.1.93
|
|
|
+ */
|
|
|
+ path: string | Buffer;
|
|
|
+ /**
|
|
|
+ * This property is `true` if the underlying file has not been opened yet,
|
|
|
+ * i.e. before the `'ready'` event is emitted.
|
|
|
+ * @since v11.2.0
|
|
|
+ */
|
|
|
+ pending: boolean;
|
|
|
+ // #region InternalEventEmitter
|
|
|
+ addListener<E extends keyof WriteStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: WriteStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ addListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ emit<E extends keyof WriteStreamEventMap>(eventName: E, ...args: WriteStreamEventMap[E]): boolean;
|
|
|
+ emit(eventName: string | symbol, ...args: any[]): boolean;
|
|
|
+ listenerCount<E extends keyof WriteStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener?: (...args: WriteStreamEventMap[E]) => void,
|
|
|
+ ): number;
|
|
|
+ listenerCount(eventName: string | symbol, listener?: (...args: any[]) => void): number;
|
|
|
+ listeners<E extends keyof WriteStreamEventMap>(eventName: E): ((...args: WriteStreamEventMap[E]) => void)[];
|
|
|
+ listeners(eventName: string | symbol): ((...args: any[]) => void)[];
|
|
|
+ off<E extends keyof WriteStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: WriteStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ off(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ on<E extends keyof WriteStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: WriteStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ on(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ once<E extends keyof WriteStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: WriteStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ once(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ prependListener<E extends keyof WriteStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: WriteStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ prependListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ prependOnceListener<E extends keyof WriteStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: WriteStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ rawListeners<E extends keyof WriteStreamEventMap>(eventName: E): ((...args: WriteStreamEventMap[E]) => void)[];
|
|
|
+ rawListeners(eventName: string | symbol): ((...args: any[]) => void)[];
|
|
|
+ // eslint-disable-next-line @definitelytyped/no-unnecessary-generics
|
|
|
+ removeAllListeners<E extends keyof WriteStreamEventMap>(eventName?: E): this;
|
|
|
+ removeAllListeners(eventName?: string | symbol): this;
|
|
|
+ removeListener<E extends keyof WriteStreamEventMap>(
|
|
|
+ eventName: E,
|
|
|
+ listener: (...args: WriteStreamEventMap[E]) => void,
|
|
|
+ ): this;
|
|
|
+ removeListener(eventName: string | symbol, listener: (...args: any[]) => void): this;
|
|
|
+ // #endregion
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Asynchronously rename file at `oldPath` to the pathname provided
|
|
|
+ * as `newPath`. In the case that `newPath` already exists, it will
|
|
|
+ * be overwritten. If there is a directory at `newPath`, an error will
|
|
|
+ * be raised instead. No arguments other than a possible exception are
|
|
|
+ * given to the completion callback.
|
|
|
+ *
|
|
|
+ * See also: [`rename(2)`](http://man7.org/linux/man-pages/man2/rename.2.html).
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { rename } from 'node:fs';
|
|
|
+ *
|
|
|
+ * rename('oldFile.txt', 'newFile.txt', (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log('Rename complete!');
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ * @since v0.0.2
|
|
|
+ */
|
|
|
+ function rename(oldPath: PathLike, newPath: PathLike, callback: NoParamCallback): void;
|
|
|
+ namespace rename {
|
|
|
+ /**
|
|
|
+ * Asynchronous rename(2) - Change the name or location of a file or directory.
|
|
|
+ * @param oldPath A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * URL support is _experimental_.
|
|
|
+ * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * URL support is _experimental_.
|
|
|
+ */
|
|
|
+ function __promisify__(oldPath: PathLike, newPath: PathLike): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Renames the file from `oldPath` to `newPath`. Returns `undefined`.
|
|
|
+ *
|
|
|
+ * See the POSIX [`rename(2)`](http://man7.org/linux/man-pages/man2/rename.2.html) documentation for more details.
|
|
|
+ * @since v0.1.21
|
|
|
+ */
|
|
|
+ function renameSync(oldPath: PathLike, newPath: PathLike): void;
|
|
|
+ /**
|
|
|
+ * Truncates the file. No arguments other than a possible exception are
|
|
|
+ * given to the completion callback. A file descriptor can also be passed as the
|
|
|
+ * first argument. In this case, `fs.ftruncate()` is called.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { truncate } from 'node:fs';
|
|
|
+ * // Assuming that 'path/file.txt' is a regular file.
|
|
|
+ * truncate('path/file.txt', (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log('path/file.txt was truncated');
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * Passing a file descriptor is deprecated and may result in an error being thrown
|
|
|
+ * in the future.
|
|
|
+ *
|
|
|
+ * See the POSIX [`truncate(2)`](http://man7.org/linux/man-pages/man2/truncate.2.html) documentation for more details.
|
|
|
+ * @since v0.8.6
|
|
|
+ * @param [len=0]
|
|
|
+ */
|
|
|
+ function truncate(path: PathLike, len: number | undefined, callback: NoParamCallback): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous truncate(2) - Truncate a file to a specified length.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function truncate(path: PathLike, callback: NoParamCallback): void;
|
|
|
+ namespace truncate {
|
|
|
+ /**
|
|
|
+ * Asynchronous truncate(2) - Truncate a file to a specified length.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param len If not specified, defaults to `0`.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, len?: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Truncates the file. Returns `undefined`. A file descriptor can also be
|
|
|
+ * passed as the first argument. In this case, `fs.ftruncateSync()` is called.
|
|
|
+ *
|
|
|
+ * Passing a file descriptor is deprecated and may result in an error being thrown
|
|
|
+ * in the future.
|
|
|
+ * @since v0.8.6
|
|
|
+ * @param [len=0]
|
|
|
+ */
|
|
|
+ function truncateSync(path: PathLike, len?: number): void;
|
|
|
+ /**
|
|
|
+ * Truncates the file descriptor. No arguments other than a possible exception are
|
|
|
+ * given to the completion callback.
|
|
|
+ *
|
|
|
+ * See the POSIX [`ftruncate(2)`](http://man7.org/linux/man-pages/man2/ftruncate.2.html) documentation for more detail.
|
|
|
+ *
|
|
|
+ * If the file referred to by the file descriptor was larger than `len` bytes, only
|
|
|
+ * the first `len` bytes will be retained in the file.
|
|
|
+ *
|
|
|
+ * For example, the following program retains only the first four bytes of the
|
|
|
+ * file:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { open, close, ftruncate } from 'node:fs';
|
|
|
+ *
|
|
|
+ * function closeFd(fd) {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * open('temp.txt', 'r+', (err, fd) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * ftruncate(fd, 4, (err) => {
|
|
|
+ * closeFd(fd);
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * } catch (err) {
|
|
|
+ * closeFd(fd);
|
|
|
+ * if (err) throw err;
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * If the file previously was shorter than `len` bytes, it is extended, and the
|
|
|
+ * extended part is filled with null bytes (`'\0'`):
|
|
|
+ *
|
|
|
+ * If `len` is negative then `0` will be used.
|
|
|
+ * @since v0.8.6
|
|
|
+ * @param [len=0]
|
|
|
+ */
|
|
|
+ function ftruncate(fd: number, len: number | undefined, callback: NoParamCallback): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous ftruncate(2) - Truncate a file to a specified length.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ */
|
|
|
+ function ftruncate(fd: number, callback: NoParamCallback): void;
|
|
|
+ namespace ftruncate {
|
|
|
+ /**
|
|
|
+ * Asynchronous ftruncate(2) - Truncate a file to a specified length.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param len If not specified, defaults to `0`.
|
|
|
+ */
|
|
|
+ function __promisify__(fd: number, len?: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Truncates the file descriptor. Returns `undefined`.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link ftruncate}.
|
|
|
+ * @since v0.8.6
|
|
|
+ * @param [len=0]
|
|
|
+ */
|
|
|
+ function ftruncateSync(fd: number, len?: number): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously changes owner and group of a file. No arguments other than a
|
|
|
+ * possible exception are given to the completion callback.
|
|
|
+ *
|
|
|
+ * See the POSIX [`chown(2)`](http://man7.org/linux/man-pages/man2/chown.2.html) documentation for more detail.
|
|
|
+ * @since v0.1.97
|
|
|
+ */
|
|
|
+ function chown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void;
|
|
|
+ namespace chown {
|
|
|
+ /**
|
|
|
+ * Asynchronous chown(2) - Change ownership of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, uid: number, gid: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronously changes owner and group of a file. Returns `undefined`.
|
|
|
+ * This is the synchronous version of {@link chown}.
|
|
|
+ *
|
|
|
+ * See the POSIX [`chown(2)`](http://man7.org/linux/man-pages/man2/chown.2.html) documentation for more detail.
|
|
|
+ * @since v0.1.97
|
|
|
+ */
|
|
|
+ function chownSync(path: PathLike, uid: number, gid: number): void;
|
|
|
+ /**
|
|
|
+ * Sets the owner of the file. No arguments other than a possible exception are
|
|
|
+ * given to the completion callback.
|
|
|
+ *
|
|
|
+ * See the POSIX [`fchown(2)`](http://man7.org/linux/man-pages/man2/fchown.2.html) documentation for more detail.
|
|
|
+ * @since v0.4.7
|
|
|
+ */
|
|
|
+ function fchown(fd: number, uid: number, gid: number, callback: NoParamCallback): void;
|
|
|
+ namespace fchown {
|
|
|
+ /**
|
|
|
+ * Asynchronous fchown(2) - Change ownership of a file.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ */
|
|
|
+ function __promisify__(fd: number, uid: number, gid: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Sets the owner of the file. Returns `undefined`.
|
|
|
+ *
|
|
|
+ * See the POSIX [`fchown(2)`](http://man7.org/linux/man-pages/man2/fchown.2.html) documentation for more detail.
|
|
|
+ * @since v0.4.7
|
|
|
+ * @param uid The file's new owner's user id.
|
|
|
+ * @param gid The file's new group's group id.
|
|
|
+ */
|
|
|
+ function fchownSync(fd: number, uid: number, gid: number): void;
|
|
|
+ /**
|
|
|
+ * Set the owner of the symbolic link. No arguments other than a possible
|
|
|
+ * exception are given to the completion callback.
|
|
|
+ *
|
|
|
+ * See the POSIX [`lchown(2)`](http://man7.org/linux/man-pages/man2/lchown.2.html) documentation for more detail.
|
|
|
+ */
|
|
|
+ function lchown(path: PathLike, uid: number, gid: number, callback: NoParamCallback): void;
|
|
|
+ namespace lchown {
|
|
|
+ /**
|
|
|
+ * Asynchronous lchown(2) - Change ownership of a file. Does not dereference symbolic links.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, uid: number, gid: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Set the owner for the path. Returns `undefined`.
|
|
|
+ *
|
|
|
+ * See the POSIX [`lchown(2)`](http://man7.org/linux/man-pages/man2/lchown.2.html) documentation for more details.
|
|
|
+ * @param uid The file's new owner's user id.
|
|
|
+ * @param gid The file's new group's group id.
|
|
|
+ */
|
|
|
+ function lchownSync(path: PathLike, uid: number, gid: number): void;
|
|
|
+ /**
|
|
|
+ * Changes the access and modification times of a file in the same way as {@link utimes}, with the difference that if the path refers to a symbolic
|
|
|
+ * link, then the link is not dereferenced: instead, the timestamps of the
|
|
|
+ * symbolic link itself are changed.
|
|
|
+ *
|
|
|
+ * No arguments other than a possible exception are given to the completion
|
|
|
+ * callback.
|
|
|
+ * @since v14.5.0, v12.19.0
|
|
|
+ */
|
|
|
+ function lutimes(path: PathLike, atime: TimeLike, mtime: TimeLike, callback: NoParamCallback): void;
|
|
|
+ namespace lutimes {
|
|
|
+ /**
|
|
|
+ * Changes the access and modification times of a file in the same way as `fsPromises.utimes()`,
|
|
|
+ * with the difference that if the path refers to a symbolic link, then the link is not
|
|
|
+ * dereferenced: instead, the timestamps of the symbolic link itself are changed.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @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.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, atime: TimeLike, mtime: TimeLike): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Change the file system timestamps of the symbolic link referenced by `path`.
|
|
|
+ * Returns `undefined`, or throws an exception when parameters are incorrect or
|
|
|
+ * the operation fails. This is the synchronous version of {@link lutimes}.
|
|
|
+ * @since v14.5.0, v12.19.0
|
|
|
+ */
|
|
|
+ function lutimesSync(path: PathLike, atime: TimeLike, mtime: TimeLike): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously changes the permissions of a file. No arguments other than a
|
|
|
+ * possible exception are given to the completion callback.
|
|
|
+ *
|
|
|
+ * See the POSIX [`chmod(2)`](http://man7.org/linux/man-pages/man2/chmod.2.html) documentation for more detail.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { chmod } from 'node:fs';
|
|
|
+ *
|
|
|
+ * chmod('my_file.txt', 0o775, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log('The permissions for file "my_file.txt" have been changed!');
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ * @since v0.1.30
|
|
|
+ */
|
|
|
+ function chmod(path: PathLike, mode: Mode, callback: NoParamCallback): void;
|
|
|
+ namespace chmod {
|
|
|
+ /**
|
|
|
+ * Asynchronous chmod(2) - Change permissions of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param mode A file mode. If a string is passed, it is parsed as an octal integer.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, mode: Mode): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link chmod}.
|
|
|
+ *
|
|
|
+ * See the POSIX [`chmod(2)`](http://man7.org/linux/man-pages/man2/chmod.2.html) documentation for more detail.
|
|
|
+ * @since v0.6.7
|
|
|
+ */
|
|
|
+ function chmodSync(path: PathLike, mode: Mode): void;
|
|
|
+ /**
|
|
|
+ * Sets the permissions on the file. No arguments other than a possible exception
|
|
|
+ * are given to the completion callback.
|
|
|
+ *
|
|
|
+ * See the POSIX [`fchmod(2)`](http://man7.org/linux/man-pages/man2/fchmod.2.html) documentation for more detail.
|
|
|
+ * @since v0.4.7
|
|
|
+ */
|
|
|
+ function fchmod(fd: number, mode: Mode, callback: NoParamCallback): void;
|
|
|
+ namespace fchmod {
|
|
|
+ /**
|
|
|
+ * Asynchronous fchmod(2) - Change permissions of a file.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param mode A file mode. If a string is passed, it is parsed as an octal integer.
|
|
|
+ */
|
|
|
+ function __promisify__(fd: number, mode: Mode): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Sets the permissions on the file. Returns `undefined`.
|
|
|
+ *
|
|
|
+ * See the POSIX [`fchmod(2)`](http://man7.org/linux/man-pages/man2/fchmod.2.html) documentation for more detail.
|
|
|
+ * @since v0.4.7
|
|
|
+ */
|
|
|
+ function fchmodSync(fd: number, mode: Mode): void;
|
|
|
+ /**
|
|
|
+ * Changes the permissions on a symbolic link. No arguments other than a possible
|
|
|
+ * exception are given to the completion callback.
|
|
|
+ *
|
|
|
+ * This method is only implemented on macOS.
|
|
|
+ *
|
|
|
+ * See the POSIX [`lchmod(2)`](https://www.freebsd.org/cgi/man.cgi?query=lchmod&sektion=2) documentation for more detail.
|
|
|
+ * @deprecated Since v0.4.7
|
|
|
+ */
|
|
|
+ function lchmod(path: PathLike, mode: Mode, callback: NoParamCallback): void;
|
|
|
+ /** @deprecated */
|
|
|
+ namespace lchmod {
|
|
|
+ /**
|
|
|
+ * Asynchronous lchmod(2) - Change permissions of a file. Does not dereference symbolic links.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param mode A file mode. If a string is passed, it is parsed as an octal integer.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, mode: Mode): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Changes the permissions on a symbolic link. Returns `undefined`.
|
|
|
+ *
|
|
|
+ * This method is only implemented on macOS.
|
|
|
+ *
|
|
|
+ * See the POSIX [`lchmod(2)`](https://www.freebsd.org/cgi/man.cgi?query=lchmod&sektion=2) documentation for more detail.
|
|
|
+ * @deprecated Since v0.4.7
|
|
|
+ */
|
|
|
+ function lchmodSync(path: PathLike, mode: Mode): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous [`stat(2)`](http://man7.org/linux/man-pages/man2/stat.2.html). The callback gets two arguments `(err, stats)` where`stats` is an `fs.Stats` object.
|
|
|
+ *
|
|
|
+ * In case of an error, the `err.code` will be one of `Common System Errors`.
|
|
|
+ *
|
|
|
+ * {@link stat} follows symbolic links. Use {@link lstat} to look at the
|
|
|
+ * links themselves.
|
|
|
+ *
|
|
|
+ * Using `fs.stat()` to check for the existence of a file before calling`fs.open()`, `fs.readFile()`, or `fs.writeFile()` is not recommended.
|
|
|
+ * Instead, user code should open/read/write the file directly and handle the
|
|
|
+ * error raised if the file is not available.
|
|
|
+ *
|
|
|
+ * To check if a file exists without manipulating it afterwards, {@link access} is recommended.
|
|
|
+ *
|
|
|
+ * For example, given the following directory structure:
|
|
|
+ *
|
|
|
+ * ```text
|
|
|
+ * - txtDir
|
|
|
+ * -- file.txt
|
|
|
+ * - app.js
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The next program will check for the stats of the given paths:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { stat } from 'node:fs';
|
|
|
+ *
|
|
|
+ * const pathsToCheck = ['./txtDir', './txtDir/file.txt'];
|
|
|
+ *
|
|
|
+ * for (let i = 0; i < pathsToCheck.length; i++) {
|
|
|
+ * stat(pathsToCheck[i], (err, stats) => {
|
|
|
+ * console.log(stats.isDirectory());
|
|
|
+ * console.log(stats);
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The resulting output will resemble:
|
|
|
+ *
|
|
|
+ * ```console
|
|
|
+ * true
|
|
|
+ * Stats {
|
|
|
+ * dev: 16777220,
|
|
|
+ * mode: 16877,
|
|
|
+ * nlink: 3,
|
|
|
+ * uid: 501,
|
|
|
+ * gid: 20,
|
|
|
+ * rdev: 0,
|
|
|
+ * blksize: 4096,
|
|
|
+ * ino: 14214262,
|
|
|
+ * size: 96,
|
|
|
+ * blocks: 0,
|
|
|
+ * atimeMs: 1561174653071.963,
|
|
|
+ * mtimeMs: 1561174614583.3518,
|
|
|
+ * ctimeMs: 1561174626623.5366,
|
|
|
+ * birthtimeMs: 1561174126937.2893,
|
|
|
+ * atime: 2019-06-22T03:37:33.072Z,
|
|
|
+ * mtime: 2019-06-22T03:36:54.583Z,
|
|
|
+ * ctime: 2019-06-22T03:37:06.624Z,
|
|
|
+ * birthtime: 2019-06-22T03:28:46.937Z
|
|
|
+ * }
|
|
|
+ * false
|
|
|
+ * Stats {
|
|
|
+ * dev: 16777220,
|
|
|
+ * mode: 33188,
|
|
|
+ * nlink: 1,
|
|
|
+ * uid: 501,
|
|
|
+ * gid: 20,
|
|
|
+ * rdev: 0,
|
|
|
+ * blksize: 4096,
|
|
|
+ * ino: 14214074,
|
|
|
+ * size: 8,
|
|
|
+ * blocks: 8,
|
|
|
+ * atimeMs: 1561174616618.8555,
|
|
|
+ * mtimeMs: 1561174614584,
|
|
|
+ * ctimeMs: 1561174614583.8145,
|
|
|
+ * birthtimeMs: 1561174007710.7478,
|
|
|
+ * atime: 2019-06-22T03:36:56.619Z,
|
|
|
+ * mtime: 2019-06-22T03:36:54.584Z,
|
|
|
+ * ctime: 2019-06-22T03:36:54.584Z,
|
|
|
+ * birthtime: 2019-06-22T03:26:47.711Z
|
|
|
+ * }
|
|
|
+ * ```
|
|
|
+ * @since v0.0.2
|
|
|
+ */
|
|
|
+ function stat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void;
|
|
|
+ function stat(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | (StatOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ })
|
|
|
+ | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void,
|
|
|
+ ): void;
|
|
|
+ function stat(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void,
|
|
|
+ ): void;
|
|
|
+ function stat(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatOptions | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void,
|
|
|
+ ): void;
|
|
|
+ namespace stat {
|
|
|
+ /**
|
|
|
+ * Asynchronous stat(2) - Get file status.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options?: StatOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ },
|
|
|
+ ): Promise<Stats>;
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ ): Promise<BigIntStats>;
|
|
|
+ function __promisify__(path: PathLike, options?: StatOptions): Promise<Stats | BigIntStats>;
|
|
|
+ }
|
|
|
+ interface StatSyncFn extends Function {
|
|
|
+ (path: PathLike, options?: undefined): Stats;
|
|
|
+ (
|
|
|
+ path: PathLike,
|
|
|
+ options?: StatSyncOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ throwIfNoEntry: false;
|
|
|
+ },
|
|
|
+ ): Stats | undefined;
|
|
|
+ (
|
|
|
+ path: PathLike,
|
|
|
+ options: StatSyncOptions & {
|
|
|
+ bigint: true;
|
|
|
+ throwIfNoEntry: false;
|
|
|
+ },
|
|
|
+ ): BigIntStats | undefined;
|
|
|
+ (
|
|
|
+ path: PathLike,
|
|
|
+ options?: StatSyncOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ },
|
|
|
+ ): Stats;
|
|
|
+ (
|
|
|
+ path: PathLike,
|
|
|
+ options: StatSyncOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ ): BigIntStats;
|
|
|
+ (
|
|
|
+ path: PathLike,
|
|
|
+ options: StatSyncOptions & {
|
|
|
+ bigint: boolean;
|
|
|
+ throwIfNoEntry?: false | undefined;
|
|
|
+ },
|
|
|
+ ): Stats | BigIntStats;
|
|
|
+ (path: PathLike, options?: StatSyncOptions): Stats | BigIntStats | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronous stat(2) - Get file status.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ const statSync: StatSyncFn;
|
|
|
+ /**
|
|
|
+ * Invokes the callback with the `fs.Stats` for the file descriptor.
|
|
|
+ *
|
|
|
+ * See the POSIX [`fstat(2)`](http://man7.org/linux/man-pages/man2/fstat.2.html) documentation for more detail.
|
|
|
+ * @since v0.1.95
|
|
|
+ */
|
|
|
+ function fstat(fd: number, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void;
|
|
|
+ function fstat(
|
|
|
+ fd: number,
|
|
|
+ options:
|
|
|
+ | (StatOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ })
|
|
|
+ | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void,
|
|
|
+ ): void;
|
|
|
+ function fstat(
|
|
|
+ fd: number,
|
|
|
+ options: StatOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void,
|
|
|
+ ): void;
|
|
|
+ function fstat(
|
|
|
+ fd: number,
|
|
|
+ options: StatOptions | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void,
|
|
|
+ ): void;
|
|
|
+ namespace fstat {
|
|
|
+ /**
|
|
|
+ * Asynchronous fstat(2) - Get file status.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ fd: number,
|
|
|
+ options?: StatOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ },
|
|
|
+ ): Promise<Stats>;
|
|
|
+ function __promisify__(
|
|
|
+ fd: number,
|
|
|
+ options: StatOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ ): Promise<BigIntStats>;
|
|
|
+ function __promisify__(fd: number, options?: StatOptions): Promise<Stats | BigIntStats>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Retrieves the `fs.Stats` for the file descriptor.
|
|
|
+ *
|
|
|
+ * See the POSIX [`fstat(2)`](http://man7.org/linux/man-pages/man2/fstat.2.html) documentation for more detail.
|
|
|
+ * @since v0.1.95
|
|
|
+ */
|
|
|
+ function fstatSync(
|
|
|
+ fd: number,
|
|
|
+ options?: StatOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ },
|
|
|
+ ): Stats;
|
|
|
+ function fstatSync(
|
|
|
+ fd: number,
|
|
|
+ options: StatOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ ): BigIntStats;
|
|
|
+ function fstatSync(fd: number, options?: StatOptions): Stats | BigIntStats;
|
|
|
+ /**
|
|
|
+ * Retrieves the `fs.Stats` for the symbolic link referred to by the path.
|
|
|
+ * The callback gets two arguments `(err, stats)` where `stats` is a `fs.Stats` object. `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.
|
|
|
+ *
|
|
|
+ * See the POSIX [`lstat(2)`](http://man7.org/linux/man-pages/man2/lstat.2.html) documentation for more details.
|
|
|
+ * @since v0.1.30
|
|
|
+ */
|
|
|
+ function lstat(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void): void;
|
|
|
+ function lstat(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | (StatOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ })
|
|
|
+ | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: Stats) => void,
|
|
|
+ ): void;
|
|
|
+ function lstat(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: BigIntStats) => void,
|
|
|
+ ): void;
|
|
|
+ function lstat(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatOptions | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: Stats | BigIntStats) => void,
|
|
|
+ ): void;
|
|
|
+ namespace lstat {
|
|
|
+ /**
|
|
|
+ * Asynchronous lstat(2) - Get file status. Does not dereference symbolic links.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options?: StatOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ },
|
|
|
+ ): Promise<Stats>;
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ ): Promise<BigIntStats>;
|
|
|
+ function __promisify__(path: PathLike, options?: StatOptions): Promise<Stats | BigIntStats>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Asynchronous [`statfs(2)`](http://man7.org/linux/man-pages/man2/statfs.2.html). Returns information about the mounted file system which
|
|
|
+ * contains `path`. The callback gets two arguments `(err, stats)` where `stats`is an `fs.StatFs` object.
|
|
|
+ *
|
|
|
+ * In case of an error, the `err.code` will be one of `Common System Errors`.
|
|
|
+ * @since v19.6.0, v18.15.0
|
|
|
+ * @param path A path to an existing file or directory on the file system to be queried.
|
|
|
+ */
|
|
|
+ function statfs(path: PathLike, callback: (err: NodeJS.ErrnoException | null, stats: StatsFs) => void): void;
|
|
|
+ function statfs(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | (StatFsOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ })
|
|
|
+ | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: StatsFs) => void,
|
|
|
+ ): void;
|
|
|
+ function statfs(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatFsOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: BigIntStatsFs) => void,
|
|
|
+ ): void;
|
|
|
+ function statfs(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatFsOptions | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, stats: StatsFs | BigIntStatsFs) => void,
|
|
|
+ ): void;
|
|
|
+ namespace statfs {
|
|
|
+ /**
|
|
|
+ * Asynchronous statfs(2) - Returns information about the mounted file system which contains path. The callback gets two arguments (err, stats) where stats is an <fs.StatFs> object.
|
|
|
+ * @param path A path to an existing file or directory on the file system to be queried.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options?: StatFsOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ },
|
|
|
+ ): Promise<StatsFs>;
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatFsOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ ): Promise<BigIntStatsFs>;
|
|
|
+ function __promisify__(path: PathLike, options?: StatFsOptions): Promise<StatsFs | BigIntStatsFs>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronous [`statfs(2)`](http://man7.org/linux/man-pages/man2/statfs.2.html). Returns information about the mounted file system which
|
|
|
+ * contains `path`.
|
|
|
+ *
|
|
|
+ * In case of an error, the `err.code` will be one of `Common System Errors`.
|
|
|
+ * @since v19.6.0, v18.15.0
|
|
|
+ * @param path A path to an existing file or directory on the file system to be queried.
|
|
|
+ */
|
|
|
+ function statfsSync(
|
|
|
+ path: PathLike,
|
|
|
+ options?: StatFsOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ },
|
|
|
+ ): StatsFs;
|
|
|
+ function statfsSync(
|
|
|
+ path: PathLike,
|
|
|
+ options: StatFsOptions & {
|
|
|
+ bigint: true;
|
|
|
+ },
|
|
|
+ ): BigIntStatsFs;
|
|
|
+ function statfsSync(path: PathLike, options?: StatFsOptions): StatsFs | BigIntStatsFs;
|
|
|
+ /**
|
|
|
+ * Synchronous lstat(2) - Get file status. Does not dereference symbolic links.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ const lstatSync: StatSyncFn;
|
|
|
+ /**
|
|
|
+ * Creates a new link from the `existingPath` to the `newPath`. See the POSIX [`link(2)`](http://man7.org/linux/man-pages/man2/link.2.html) documentation for more detail. No arguments other than
|
|
|
+ * a possible
|
|
|
+ * exception are given to the completion callback.
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function link(existingPath: PathLike, newPath: PathLike, callback: NoParamCallback): void;
|
|
|
+ namespace link {
|
|
|
+ /**
|
|
|
+ * Asynchronous link(2) - Create a new link (also known as a hard link) to an existing file.
|
|
|
+ * @param existingPath A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param newPath A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function __promisify__(existingPath: PathLike, newPath: PathLike): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Creates a new link from the `existingPath` to the `newPath`. See the POSIX [`link(2)`](http://man7.org/linux/man-pages/man2/link.2.html) documentation for more detail. Returns `undefined`.
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function linkSync(existingPath: PathLike, newPath: PathLike): void;
|
|
|
+ /**
|
|
|
+ * Creates the link called `path` pointing to `target`. No arguments other than a
|
|
|
+ * possible exception are given to the completion callback.
|
|
|
+ *
|
|
|
+ * See the POSIX [`symlink(2)`](http://man7.org/linux/man-pages/man2/symlink.2.html) documentation for more details.
|
|
|
+ *
|
|
|
+ * The `type` argument is only available on Windows and ignored on other platforms.
|
|
|
+ * It can be set to `'dir'`, `'file'`, or `'junction'`. If the `type` argument is
|
|
|
+ * not a string, Node.js will autodetect `target` type and use `'file'` or `'dir'`.
|
|
|
+ * If the `target` does not exist, `'file'` will be used. Windows junction points
|
|
|
+ * require the destination path to be absolute. When using `'junction'`, the`target` argument will automatically be normalized to absolute path. Junction
|
|
|
+ * points on NTFS volumes can only point to directories.
|
|
|
+ *
|
|
|
+ * Relative targets are relative to the link's parent directory.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { symlink } from 'node:fs';
|
|
|
+ *
|
|
|
+ * symlink('./mew', './mewtwo', callback);
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The above example creates a symbolic link `mewtwo` which points to `mew` in the
|
|
|
+ * same directory:
|
|
|
+ *
|
|
|
+ * ```bash
|
|
|
+ * $ tree .
|
|
|
+ * .
|
|
|
+ * ├── mew
|
|
|
+ * └── mewtwo -> ./mew
|
|
|
+ * ```
|
|
|
+ * @since v0.1.31
|
|
|
+ * @param [type='null']
|
|
|
+ */
|
|
|
+ function symlink(
|
|
|
+ target: PathLike,
|
|
|
+ path: PathLike,
|
|
|
+ type: symlink.Type | undefined | null,
|
|
|
+ callback: NoParamCallback,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous symlink(2) - Create a new symbolic link to an existing file.
|
|
|
+ * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function symlink(target: PathLike, path: PathLike, callback: NoParamCallback): void;
|
|
|
+ namespace symlink {
|
|
|
+ /**
|
|
|
+ * Asynchronous symlink(2) - Create a new symbolic link to an existing file.
|
|
|
+ * @param target A path to an existing file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param path A path to the new symlink. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param type May be set to `'dir'`, `'file'`, or `'junction'` (default is `'file'`) and is only available on Windows (ignored on other platforms).
|
|
|
+ * When using `'junction'`, the `target` argument will automatically be normalized to an absolute path.
|
|
|
+ */
|
|
|
+ function __promisify__(target: PathLike, path: PathLike, type?: string | null): Promise<void>;
|
|
|
+ type Type = "dir" | "file" | "junction";
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns `undefined`.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link symlink}.
|
|
|
+ * @since v0.1.31
|
|
|
+ * @param [type='null']
|
|
|
+ */
|
|
|
+ function symlinkSync(target: PathLike, path: PathLike, type?: symlink.Type | null): void;
|
|
|
+ /**
|
|
|
+ * Reads the contents of the symbolic link referred to by `path`. The callback gets
|
|
|
+ * two arguments `(err, linkString)`.
|
|
|
+ *
|
|
|
+ * See the POSIX [`readlink(2)`](http://man7.org/linux/man-pages/man2/readlink.2.html) documentation for more details.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use for
|
|
|
+ * the link path passed to the callback. If the `encoding` is set to `'buffer'`,
|
|
|
+ * the link path returned will be passed as a `Buffer` object.
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function readlink(
|
|
|
+ path: PathLike,
|
|
|
+ options: EncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, linkString: string) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous readlink(2) - read value of a symbolic link.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function readlink(
|
|
|
+ path: PathLike,
|
|
|
+ options: BufferEncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, linkString: NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous readlink(2) - read value of a symbolic link.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function readlink(
|
|
|
+ path: PathLike,
|
|
|
+ options: EncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, linkString: string | NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous readlink(2) - read value of a symbolic link.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function readlink(
|
|
|
+ path: PathLike,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, linkString: string) => void,
|
|
|
+ ): void;
|
|
|
+ namespace readlink {
|
|
|
+ /**
|
|
|
+ * Asynchronous readlink(2) - read value of a symbolic link.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, options?: EncodingOption): Promise<string>;
|
|
|
+ /**
|
|
|
+ * Asynchronous readlink(2) - read value of a symbolic link.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, options: BufferEncodingOption): Promise<NonSharedBuffer>;
|
|
|
+ /**
|
|
|
+ * Asynchronous readlink(2) - read value of a symbolic link.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, options?: EncodingOption): Promise<string | NonSharedBuffer>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns the symbolic link's string value.
|
|
|
+ *
|
|
|
+ * See the POSIX [`readlink(2)`](http://man7.org/linux/man-pages/man2/readlink.2.html) documentation for more details.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use for
|
|
|
+ * the link path returned. If the `encoding` is set to `'buffer'`,
|
|
|
+ * the link path returned will be passed as a `Buffer` object.
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function readlinkSync(path: PathLike, options?: EncodingOption): string;
|
|
|
+ /**
|
|
|
+ * Synchronous readlink(2) - read value of a symbolic link.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function readlinkSync(path: PathLike, options: BufferEncodingOption): NonSharedBuffer;
|
|
|
+ /**
|
|
|
+ * Synchronous readlink(2) - read value of a symbolic link.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function readlinkSync(path: PathLike, options?: EncodingOption): string | NonSharedBuffer;
|
|
|
+ /**
|
|
|
+ * Asynchronously computes the canonical pathname by resolving `.`, `..`, and
|
|
|
+ * symbolic links.
|
|
|
+ *
|
|
|
+ * A canonical pathname is not necessarily unique. Hard links and bind mounts can
|
|
|
+ * expose a file system entity through many pathnames.
|
|
|
+ *
|
|
|
+ * This function behaves like [`realpath(3)`](http://man7.org/linux/man-pages/man3/realpath.3.html), with some exceptions:
|
|
|
+ *
|
|
|
+ * 1. No case conversion is performed on case-insensitive file systems.
|
|
|
+ * 2. The maximum number of symbolic links is platform-independent and generally
|
|
|
+ * (much) higher than what the native [`realpath(3)`](http://man7.org/linux/man-pages/man3/realpath.3.html) implementation supports.
|
|
|
+ *
|
|
|
+ * The `callback` gets two arguments `(err, resolvedPath)`. May use `process.cwd` to resolve relative paths.
|
|
|
+ *
|
|
|
+ * Only paths that can be converted to UTF8 strings are supported.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use for
|
|
|
+ * the path passed to the callback. If the `encoding` is set to `'buffer'`,
|
|
|
+ * the path returned will be passed as a `Buffer` object.
|
|
|
+ *
|
|
|
+ * If `path` resolves to a socket or a pipe, the function will return a system
|
|
|
+ * dependent name for that object.
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function realpath(
|
|
|
+ path: PathLike,
|
|
|
+ options: EncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * 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. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function realpath(
|
|
|
+ path: PathLike,
|
|
|
+ options: BufferEncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, resolvedPath: NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * 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. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function realpath(
|
|
|
+ path: PathLike,
|
|
|
+ options: EncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * 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.
|
|
|
+ */
|
|
|
+ function realpath(
|
|
|
+ path: PathLike,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void,
|
|
|
+ ): void;
|
|
|
+ namespace realpath {
|
|
|
+ /**
|
|
|
+ * 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. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, options?: EncodingOption): Promise<string>;
|
|
|
+ /**
|
|
|
+ * 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. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, options: BufferEncodingOption): Promise<NonSharedBuffer>;
|
|
|
+ /**
|
|
|
+ * 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. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, options?: EncodingOption): Promise<string | NonSharedBuffer>;
|
|
|
+ /**
|
|
|
+ * Asynchronous [`realpath(3)`](http://man7.org/linux/man-pages/man3/realpath.3.html).
|
|
|
+ *
|
|
|
+ * The `callback` gets two arguments `(err, resolvedPath)`.
|
|
|
+ *
|
|
|
+ * Only paths that can be converted to UTF8 strings are supported.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use for
|
|
|
+ * the path passed to the callback. If the `encoding` is set to `'buffer'`,
|
|
|
+ * the path returned will be passed as a `Buffer` object.
|
|
|
+ *
|
|
|
+ * On Linux, when Node.js is linked against musl libc, the procfs file system must
|
|
|
+ * be mounted on `/proc` in order for this function to work. Glibc does not have
|
|
|
+ * this restriction.
|
|
|
+ * @since v9.2.0
|
|
|
+ */
|
|
|
+ function native(
|
|
|
+ path: PathLike,
|
|
|
+ options: EncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void,
|
|
|
+ ): void;
|
|
|
+ function native(
|
|
|
+ path: PathLike,
|
|
|
+ options: BufferEncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, resolvedPath: NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ function native(
|
|
|
+ path: PathLike,
|
|
|
+ options: EncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, resolvedPath: string | NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ function native(
|
|
|
+ path: PathLike,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, resolvedPath: string) => void,
|
|
|
+ ): void;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns the resolved pathname.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link realpath}.
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function realpathSync(path: PathLike, options?: EncodingOption): string;
|
|
|
+ /**
|
|
|
+ * Synchronous 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. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function realpathSync(path: PathLike, options: BufferEncodingOption): NonSharedBuffer;
|
|
|
+ /**
|
|
|
+ * Synchronous 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. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function realpathSync(path: PathLike, options?: EncodingOption): string | NonSharedBuffer;
|
|
|
+ namespace realpathSync {
|
|
|
+ function native(path: PathLike, options?: EncodingOption): string;
|
|
|
+ function native(path: PathLike, options: BufferEncodingOption): NonSharedBuffer;
|
|
|
+ function native(path: PathLike, options?: EncodingOption): string | NonSharedBuffer;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Asynchronously removes a file or symbolic link. No arguments other than a
|
|
|
+ * possible exception are given to the completion callback.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { unlink } from 'node:fs';
|
|
|
+ * // Assuming that 'path/file.txt' is a regular file.
|
|
|
+ * unlink('path/file.txt', (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log('path/file.txt was deleted');
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * `fs.unlink()` will not work on a directory, empty or otherwise. To remove a
|
|
|
+ * directory, use {@link rmdir}.
|
|
|
+ *
|
|
|
+ * See the POSIX [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html) documentation for more details.
|
|
|
+ * @since v0.0.2
|
|
|
+ */
|
|
|
+ function unlink(path: PathLike, callback: NoParamCallback): void;
|
|
|
+ namespace unlink {
|
|
|
+ /**
|
|
|
+ * Asynchronous unlink(2) - delete a name and possibly the file it refers to.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronous [`unlink(2)`](http://man7.org/linux/man-pages/man2/unlink.2.html). Returns `undefined`.
|
|
|
+ * @since v0.1.21
|
|
|
+ */
|
|
|
+ function unlinkSync(path: PathLike): void;
|
|
|
+ /** @deprecated `rmdir()` no longer provides any options. This interface will be removed in a future version. */
|
|
|
+ // TODO: remove in future major
|
|
|
+ interface RmDirOptions {}
|
|
|
+ /**
|
|
|
+ * Asynchronous [`rmdir(2)`](http://man7.org/linux/man-pages/man2/rmdir.2.html). No arguments other than a possible exception are given
|
|
|
+ * to the completion callback.
|
|
|
+ *
|
|
|
+ * Using `fs.rmdir()` on a file (not a directory) results in an `ENOENT` error on
|
|
|
+ * Windows and an `ENOTDIR` error on POSIX.
|
|
|
+ *
|
|
|
+ * To get a behavior similar to the `rm -rf` Unix command, use {@link rm} with options `{ recursive: true, force: true }`.
|
|
|
+ * @since v0.0.2
|
|
|
+ */
|
|
|
+ function rmdir(path: PathLike, callback: NoParamCallback): void;
|
|
|
+ namespace rmdir {
|
|
|
+ /**
|
|
|
+ * Asynchronous rmdir(2) - delete a directory.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronous [`rmdir(2)`](http://man7.org/linux/man-pages/man2/rmdir.2.html). Returns `undefined`.
|
|
|
+ *
|
|
|
+ * Using `fs.rmdirSync()` on a file (not a directory) results in an `ENOENT` error
|
|
|
+ * on Windows and an `ENOTDIR` error on POSIX.
|
|
|
+ *
|
|
|
+ * To get a behavior similar to the `rm -rf` Unix command, use {@link rmSync} with options `{ recursive: true, force: true }`.
|
|
|
+ * @since v0.1.21
|
|
|
+ */
|
|
|
+ function rmdirSync(path: PathLike): void;
|
|
|
+ interface RmOptions {
|
|
|
+ /**
|
|
|
+ * When `true`, exceptions will be ignored if `path` does not exist.
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ force?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
|
|
|
+ * `EPERM` error is encountered, Node.js will retry the operation with a linear
|
|
|
+ * backoff wait of `retryDelay` ms longer on each try. This option represents the
|
|
|
+ * number of retries. This option is ignored if the `recursive` option is not
|
|
|
+ * `true`.
|
|
|
+ * @default 0
|
|
|
+ */
|
|
|
+ maxRetries?: number | undefined;
|
|
|
+ /**
|
|
|
+ * If `true`, perform a recursive directory removal. In
|
|
|
+ * recursive mode, operations are retried on failure.
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * The amount of time in milliseconds to wait between retries.
|
|
|
+ * This option is ignored if the `recursive` option is not `true`.
|
|
|
+ * @default 100
|
|
|
+ */
|
|
|
+ retryDelay?: number | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Asynchronously removes files and directories (modeled on the standard POSIX `rm` utility). No arguments other than a possible exception are given to the
|
|
|
+ * completion callback.
|
|
|
+ * @since v14.14.0
|
|
|
+ */
|
|
|
+ function rm(path: PathLike, callback: NoParamCallback): void;
|
|
|
+ function rm(path: PathLike, options: RmOptions, callback: NoParamCallback): void;
|
|
|
+ namespace rm {
|
|
|
+ /**
|
|
|
+ * Asynchronously removes files and directories (modeled on the standard POSIX `rm` utility).
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, options?: RmOptions): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronously removes files and directories (modeled on the standard POSIX `rm` utility). Returns `undefined`.
|
|
|
+ * @since v14.14.0
|
|
|
+ */
|
|
|
+ function rmSync(path: PathLike, options?: RmOptions): void;
|
|
|
+ interface MakeDirectoryOptions {
|
|
|
+ /**
|
|
|
+ * Indicates whether parent folders should be created.
|
|
|
+ * If a folder was created, the path to the first created folder will be returned.
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * A file mode. If a string is passed, it is parsed as an octal integer. If not specified
|
|
|
+ * @default 0o777
|
|
|
+ */
|
|
|
+ mode?: Mode | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Asynchronously creates a directory.
|
|
|
+ *
|
|
|
+ * The callback is given a possible exception and, if `recursive` is `true`, the
|
|
|
+ * first directory path created, `(err[, path])`.`path` can still be `undefined` when `recursive` is `true`, if no directory was
|
|
|
+ * created (for instance, if it was previously created).
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be an integer specifying `mode` (permission
|
|
|
+ * and sticky bits), or an object with a `mode` property and a `recursive` property indicating whether parent directories should be created. Calling `fs.mkdir()` when `path` is a directory that
|
|
|
+ * exists results in an error only
|
|
|
+ * when `recursive` is false. If `recursive` is false and the directory exists,
|
|
|
+ * an `EEXIST` error occurs.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { mkdir } from 'node:fs';
|
|
|
+ *
|
|
|
+ * // Create ./tmp/a/apple, regardless of whether ./tmp and ./tmp/a exist.
|
|
|
+ * mkdir('./tmp/a/apple', { recursive: true }, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * On Windows, using `fs.mkdir()` on the root directory even with recursion will
|
|
|
+ * result in an error:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { mkdir } from 'node:fs';
|
|
|
+ *
|
|
|
+ * mkdir('/', { recursive: true }, (err) => {
|
|
|
+ * // => [Error: EPERM: operation not permitted, mkdir 'C:\']
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * See the POSIX [`mkdir(2)`](http://man7.org/linux/man-pages/man2/mkdir.2.html) documentation for more details.
|
|
|
+ * @since v0.1.8
|
|
|
+ */
|
|
|
+ function mkdir(
|
|
|
+ path: PathLike,
|
|
|
+ options: MakeDirectoryOptions & {
|
|
|
+ recursive: true;
|
|
|
+ },
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, path?: string) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * 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`.
|
|
|
+ */
|
|
|
+ function mkdir(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | Mode
|
|
|
+ | (MakeDirectoryOptions & {
|
|
|
+ recursive?: false | undefined;
|
|
|
+ })
|
|
|
+ | null
|
|
|
+ | undefined,
|
|
|
+ callback: NoParamCallback,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * 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`.
|
|
|
+ */
|
|
|
+ function mkdir(
|
|
|
+ path: PathLike,
|
|
|
+ options: Mode | MakeDirectoryOptions | null | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, path?: string) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous mkdir(2) - create a directory with a mode of `0o777`.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function mkdir(path: PathLike, callback: NoParamCallback): void;
|
|
|
+ namespace mkdir {
|
|
|
+ /**
|
|
|
+ * 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`.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options: MakeDirectoryOptions & {
|
|
|
+ recursive: true;
|
|
|
+ },
|
|
|
+ ): Promise<string | undefined>;
|
|
|
+ /**
|
|
|
+ * 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`.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options?:
|
|
|
+ | Mode
|
|
|
+ | (MakeDirectoryOptions & {
|
|
|
+ recursive?: false | undefined;
|
|
|
+ })
|
|
|
+ | null,
|
|
|
+ ): Promise<void>;
|
|
|
+ /**
|
|
|
+ * 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`.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options?: Mode | MakeDirectoryOptions | null,
|
|
|
+ ): Promise<string | undefined>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronously creates a directory. Returns `undefined`, or if `recursive` is `true`, the first directory path created.
|
|
|
+ * This is the synchronous version of {@link mkdir}.
|
|
|
+ *
|
|
|
+ * See the POSIX [`mkdir(2)`](http://man7.org/linux/man-pages/man2/mkdir.2.html) documentation for more details.
|
|
|
+ * @since v0.1.21
|
|
|
+ */
|
|
|
+ function mkdirSync(
|
|
|
+ path: PathLike,
|
|
|
+ options: MakeDirectoryOptions & {
|
|
|
+ recursive: true;
|
|
|
+ },
|
|
|
+ ): string | undefined;
|
|
|
+ /**
|
|
|
+ * Synchronous 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`.
|
|
|
+ */
|
|
|
+ function mkdirSync(
|
|
|
+ path: PathLike,
|
|
|
+ options?:
|
|
|
+ | Mode
|
|
|
+ | (MakeDirectoryOptions & {
|
|
|
+ recursive?: false | undefined;
|
|
|
+ })
|
|
|
+ | null,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Synchronous 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`.
|
|
|
+ */
|
|
|
+ function mkdirSync(path: PathLike, options?: Mode | MakeDirectoryOptions | null): string | undefined;
|
|
|
+ /**
|
|
|
+ * Creates a unique temporary directory.
|
|
|
+ *
|
|
|
+ * Generates six random characters to be appended behind a required `prefix` to create a unique temporary directory. Due to platform
|
|
|
+ * inconsistencies, avoid trailing `X` characters in `prefix`. Some platforms,
|
|
|
+ * notably the BSDs, can return more than six random characters, and replace
|
|
|
+ * trailing `X` characters in `prefix` with random characters.
|
|
|
+ *
|
|
|
+ * The created directory path is passed as a string to the callback's second
|
|
|
+ * parameter.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { mkdtemp } from 'node:fs';
|
|
|
+ * import { join } from 'node:path';
|
|
|
+ * import { tmpdir } from 'node:os';
|
|
|
+ *
|
|
|
+ * mkdtemp(join(tmpdir(), 'foo-'), (err, directory) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log(directory);
|
|
|
+ * // Prints: /tmp/foo-itXde2 or C:\Users\...\AppData\Local\Temp\foo-itXde2
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The `fs.mkdtemp()` method will append the six randomly selected characters
|
|
|
+ * directly to the `prefix` string. For instance, given a directory `/tmp`, if the
|
|
|
+ * intention is to create a temporary directory _within_`/tmp`, the `prefix`must end with a trailing platform-specific path separator
|
|
|
+ * (`import { sep } from 'node:path'`).
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { tmpdir } from 'node:os';
|
|
|
+ * import { mkdtemp } from 'node:fs';
|
|
|
+ *
|
|
|
+ * // The parent directory for the new temporary directory
|
|
|
+ * const tmpDir = tmpdir();
|
|
|
+ *
|
|
|
+ * // This method is *INCORRECT*:
|
|
|
+ * mkdtemp(tmpDir, (err, directory) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log(directory);
|
|
|
+ * // Will print something similar to `/tmpabc123`.
|
|
|
+ * // A new temporary directory is created at the file system root
|
|
|
+ * // rather than *within* the /tmp directory.
|
|
|
+ * });
|
|
|
+ *
|
|
|
+ * // This method is *CORRECT*:
|
|
|
+ * import { sep } from 'node:path';
|
|
|
+ * mkdtemp(`${tmpDir}${sep}`, (err, directory) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log(directory);
|
|
|
+ * // Will print something similar to `/tmp/abc123`.
|
|
|
+ * // A new temporary directory is created within
|
|
|
+ * // the /tmp directory.
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ * @since v5.10.0
|
|
|
+ */
|
|
|
+ function mkdtemp(
|
|
|
+ prefix: string,
|
|
|
+ options: EncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, folder: string) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously creates a unique temporary directory.
|
|
|
+ * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
|
|
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function mkdtemp(
|
|
|
+ prefix: string,
|
|
|
+ options: BufferEncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, folder: NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously creates a unique temporary directory.
|
|
|
+ * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
|
|
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function mkdtemp(
|
|
|
+ prefix: string,
|
|
|
+ options: EncodingOption,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, folder: string | NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously creates a unique temporary directory.
|
|
|
+ * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
|
|
+ */
|
|
|
+ function mkdtemp(
|
|
|
+ prefix: string,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, folder: string) => void,
|
|
|
+ ): void;
|
|
|
+ namespace mkdtemp {
|
|
|
+ /**
|
|
|
+ * Asynchronously creates a unique temporary directory.
|
|
|
+ * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
|
|
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(prefix: string, options?: EncodingOption): Promise<string>;
|
|
|
+ /**
|
|
|
+ * Asynchronously creates a unique temporary directory.
|
|
|
+ * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
|
|
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(prefix: string, options: BufferEncodingOption): Promise<NonSharedBuffer>;
|
|
|
+ /**
|
|
|
+ * Asynchronously creates a unique temporary directory.
|
|
|
+ * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
|
|
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(prefix: string, options?: EncodingOption): Promise<string | NonSharedBuffer>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns the created directory path.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link mkdtemp}.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use.
|
|
|
+ * @since v5.10.0
|
|
|
+ */
|
|
|
+ function mkdtempSync(prefix: string, options?: EncodingOption): string;
|
|
|
+ /**
|
|
|
+ * Synchronously creates a unique temporary directory.
|
|
|
+ * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
|
|
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function mkdtempSync(prefix: string, options: BufferEncodingOption): NonSharedBuffer;
|
|
|
+ /**
|
|
|
+ * Synchronously creates a unique temporary directory.
|
|
|
+ * Generates six random characters to be appended behind a required prefix to create a unique temporary directory.
|
|
|
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'` is used.
|
|
|
+ */
|
|
|
+ function mkdtempSync(prefix: string, options?: EncodingOption): string | NonSharedBuffer;
|
|
|
+ interface DisposableTempDir extends Disposable {
|
|
|
+ /**
|
|
|
+ * The path of the created directory.
|
|
|
+ */
|
|
|
+ path: string;
|
|
|
+ /**
|
|
|
+ * A function which removes the created directory.
|
|
|
+ */
|
|
|
+ remove(): void;
|
|
|
+ /**
|
|
|
+ * The same as `remove`.
|
|
|
+ */
|
|
|
+ [Symbol.dispose](): void;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns a disposable object whose `path` property holds the created directory
|
|
|
+ * path. When the object is disposed, the directory and its contents will be
|
|
|
+ * removed if it still exists. If the directory cannot be deleted, disposal will
|
|
|
+ * throw an error. The object has a `remove()` method which will perform the same
|
|
|
+ * task.
|
|
|
+ *
|
|
|
+ * <!-- TODO: link MDN docs for disposables once https://github.com/mdn/content/pull/38027 lands -->
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of `fs.mkdtemp()`.
|
|
|
+ *
|
|
|
+ * There is no callback-based version of this API because it is designed for use
|
|
|
+ * with the `using` syntax.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use.
|
|
|
+ * @since v24.4.0
|
|
|
+ */
|
|
|
+ function mkdtempDisposableSync(prefix: string, options?: EncodingOption): DisposableTempDir;
|
|
|
+ /**
|
|
|
+ * Reads the contents of a directory. The callback gets two arguments `(err, files)` where `files` is an array of the names of the files in the directory excluding `'.'` and `'..'`.
|
|
|
+ *
|
|
|
+ * See the POSIX [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) documentation for more details.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use for
|
|
|
+ * the filenames passed to the callback. If the `encoding` is set to `'buffer'`,
|
|
|
+ * the filenames returned will be passed as `Buffer` objects.
|
|
|
+ *
|
|
|
+ * If `options.withFileTypes` is set to `true`, the `files` array will contain `fs.Dirent` objects.
|
|
|
+ * @since v0.1.8
|
|
|
+ */
|
|
|
+ function readdir(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | {
|
|
|
+ encoding: BufferEncoding | null;
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ }
|
|
|
+ | BufferEncoding
|
|
|
+ | undefined
|
|
|
+ | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, files: string[]) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function readdir(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | {
|
|
|
+ encoding: "buffer";
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ }
|
|
|
+ | "buffer",
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, files: NonSharedBuffer[]) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function readdir(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | (ObjectEncodingOptions & {
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ })
|
|
|
+ | BufferEncoding
|
|
|
+ | undefined
|
|
|
+ | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, files: string[] | NonSharedBuffer[]) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function readdir(
|
|
|
+ path: PathLike,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, files: string[]) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param options If called with `withFileTypes: true` the result data will be an array of Dirent.
|
|
|
+ */
|
|
|
+ function readdir(
|
|
|
+ path: PathLike,
|
|
|
+ options: ObjectEncodingOptions & {
|
|
|
+ withFileTypes: true;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ },
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, files: Dirent[]) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param options Must include `withFileTypes: true` and `encoding: 'buffer'`.
|
|
|
+ */
|
|
|
+ function readdir(
|
|
|
+ path: PathLike,
|
|
|
+ options: {
|
|
|
+ encoding: "buffer";
|
|
|
+ withFileTypes: true;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ },
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, files: Dirent<NonSharedBuffer>[]) => void,
|
|
|
+ ): void;
|
|
|
+ namespace readdir {
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options?:
|
|
|
+ | {
|
|
|
+ encoding: BufferEncoding | null;
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ }
|
|
|
+ | BufferEncoding
|
|
|
+ | null,
|
|
|
+ ): Promise<string[]>;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | "buffer"
|
|
|
+ | {
|
|
|
+ encoding: "buffer";
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ },
|
|
|
+ ): Promise<NonSharedBuffer[]>;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options?:
|
|
|
+ | (ObjectEncodingOptions & {
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ })
|
|
|
+ | BufferEncoding
|
|
|
+ | null,
|
|
|
+ ): Promise<string[] | NonSharedBuffer[]>;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param options If called with `withFileTypes: true` the result data will be an array of Dirent
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options: ObjectEncodingOptions & {
|
|
|
+ withFileTypes: true;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ },
|
|
|
+ ): Promise<Dirent[]>;
|
|
|
+ /**
|
|
|
+ * Asynchronous readdir(3) - read a directory.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param options Must include `withFileTypes: true` and `encoding: 'buffer'`.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathLike,
|
|
|
+ options: {
|
|
|
+ encoding: "buffer";
|
|
|
+ withFileTypes: true;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ },
|
|
|
+ ): Promise<Dirent<NonSharedBuffer>[]>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Reads the contents of the directory.
|
|
|
+ *
|
|
|
+ * See the POSIX [`readdir(3)`](http://man7.org/linux/man-pages/man3/readdir.3.html) documentation for more details.
|
|
|
+ *
|
|
|
+ * The optional `options` argument can be a string specifying an encoding, or an
|
|
|
+ * object with an `encoding` property specifying the character encoding to use for
|
|
|
+ * the filenames returned. If the `encoding` is set to `'buffer'`,
|
|
|
+ * the filenames returned will be passed as `Buffer` objects.
|
|
|
+ *
|
|
|
+ * If `options.withFileTypes` is set to `true`, the result will contain `fs.Dirent` objects.
|
|
|
+ * @since v0.1.21
|
|
|
+ */
|
|
|
+ function readdirSync(
|
|
|
+ path: PathLike,
|
|
|
+ options?:
|
|
|
+ | {
|
|
|
+ encoding: BufferEncoding | null;
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ }
|
|
|
+ | BufferEncoding
|
|
|
+ | null,
|
|
|
+ ): string[];
|
|
|
+ /**
|
|
|
+ * Synchronous readdir(3) - read a directory.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function readdirSync(
|
|
|
+ path: PathLike,
|
|
|
+ options:
|
|
|
+ | {
|
|
|
+ encoding: "buffer";
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ }
|
|
|
+ | "buffer",
|
|
|
+ ): NonSharedBuffer[];
|
|
|
+ /**
|
|
|
+ * Synchronous readdir(3) - read a directory.
|
|
|
+ * @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'` is used.
|
|
|
+ */
|
|
|
+ function readdirSync(
|
|
|
+ path: PathLike,
|
|
|
+ options?:
|
|
|
+ | (ObjectEncodingOptions & {
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ })
|
|
|
+ | BufferEncoding
|
|
|
+ | null,
|
|
|
+ ): string[] | NonSharedBuffer[];
|
|
|
+ /**
|
|
|
+ * Synchronous readdir(3) - read a directory.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param options If called with `withFileTypes: true` the result data will be an array of Dirent.
|
|
|
+ */
|
|
|
+ function readdirSync(
|
|
|
+ path: PathLike,
|
|
|
+ options: ObjectEncodingOptions & {
|
|
|
+ withFileTypes: true;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ },
|
|
|
+ ): Dirent[];
|
|
|
+ /**
|
|
|
+ * Synchronous readdir(3) - read a directory.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param options Must include `withFileTypes: true` and `encoding: 'buffer'`.
|
|
|
+ */
|
|
|
+ function readdirSync(
|
|
|
+ path: PathLike,
|
|
|
+ options: {
|
|
|
+ encoding: "buffer";
|
|
|
+ withFileTypes: true;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ },
|
|
|
+ ): Dirent<NonSharedBuffer>[];
|
|
|
+ /**
|
|
|
+ * Closes the file descriptor. No arguments other than a possible exception are
|
|
|
+ * given to the completion callback.
|
|
|
+ *
|
|
|
+ * Calling `fs.close()` on any file descriptor (`fd`) that is currently in use
|
|
|
+ * through any other `fs` operation may lead to undefined behavior.
|
|
|
+ *
|
|
|
+ * See the POSIX [`close(2)`](http://man7.org/linux/man-pages/man2/close.2.html) documentation for more detail.
|
|
|
+ * @since v0.0.2
|
|
|
+ */
|
|
|
+ function close(fd: number, callback?: NoParamCallback): void;
|
|
|
+ namespace close {
|
|
|
+ /**
|
|
|
+ * Asynchronous close(2) - close a file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ */
|
|
|
+ function __promisify__(fd: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Closes the file descriptor. Returns `undefined`.
|
|
|
+ *
|
|
|
+ * Calling `fs.closeSync()` on any file descriptor (`fd`) that is currently in use
|
|
|
+ * through any other `fs` operation may lead to undefined behavior.
|
|
|
+ *
|
|
|
+ * See the POSIX [`close(2)`](http://man7.org/linux/man-pages/man2/close.2.html) documentation for more detail.
|
|
|
+ * @since v0.1.21
|
|
|
+ */
|
|
|
+ function closeSync(fd: number): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous file open. See the POSIX [`open(2)`](http://man7.org/linux/man-pages/man2/open.2.html) documentation for more details.
|
|
|
+ *
|
|
|
+ * `mode` sets the file mode (permission and sticky bits), but only if the file was
|
|
|
+ * created. On Windows, only the write permission can be manipulated; see {@link chmod}.
|
|
|
+ *
|
|
|
+ * The callback gets two arguments `(err, fd)`.
|
|
|
+ *
|
|
|
+ * Some characters (`< > : " / \ | ? *`) are reserved under Windows as documented
|
|
|
+ * by [Naming Files, Paths, and Namespaces](https://docs.microsoft.com/en-us/windows/desktop/FileIO/naming-a-file). Under NTFS, if the filename contains
|
|
|
+ * a colon, Node.js will open a file system stream, as described by [this MSDN page](https://docs.microsoft.com/en-us/windows/desktop/FileIO/using-streams).
|
|
|
+ *
|
|
|
+ * Functions based on `fs.open()` exhibit this behavior as well:`fs.writeFile()`, `fs.readFile()`, etc.
|
|
|
+ * @since v0.0.2
|
|
|
+ * @param [flags='r'] See `support of file system `flags``.
|
|
|
+ * @param [mode=0o666]
|
|
|
+ */
|
|
|
+ function open(
|
|
|
+ path: PathLike,
|
|
|
+ flags: OpenMode | undefined,
|
|
|
+ mode: Mode | undefined | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, fd: number) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous open(2) - open and possibly create a file. If the file is created, its mode will be `0o666`.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param [flags='r'] See `support of file system `flags``.
|
|
|
+ */
|
|
|
+ function open(
|
|
|
+ path: PathLike,
|
|
|
+ flags: OpenMode | undefined,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, fd: number) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronous open(2) - open and possibly create a file. If the file is created, its mode will be `0o666`.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function open(path: PathLike, callback: (err: NodeJS.ErrnoException | null, fd: number) => void): void;
|
|
|
+ namespace open {
|
|
|
+ /**
|
|
|
+ * Asynchronous open(2) - open and possibly create a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @param mode A file mode. If a string is passed, it is parsed as an octal integer. If not supplied, defaults to `0o666`.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, flags: OpenMode, mode?: Mode | null): Promise<number>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns an integer representing the file descriptor.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link open}.
|
|
|
+ * @since v0.1.21
|
|
|
+ * @param [flags='r']
|
|
|
+ * @param [mode=0o666]
|
|
|
+ */
|
|
|
+ function openSync(path: PathLike, flags: OpenMode, mode?: Mode | null): number;
|
|
|
+ /**
|
|
|
+ * Change the file system timestamps of the object referenced by `path`.
|
|
|
+ *
|
|
|
+ * The `atime` and `mtime` arguments follow these rules:
|
|
|
+ *
|
|
|
+ * * Values can be either numbers representing Unix epoch time in seconds, `Date`s, or a numeric string like `'123456789.0'`.
|
|
|
+ * * If the value can not be converted to a number, or is `NaN`, `Infinity`, or `-Infinity`, an `Error` will be thrown.
|
|
|
+ * @since v0.4.2
|
|
|
+ */
|
|
|
+ function utimes(path: PathLike, atime: TimeLike, mtime: TimeLike, callback: NoParamCallback): void;
|
|
|
+ namespace utimes {
|
|
|
+ /**
|
|
|
+ * Asynchronously change file timestamps of the file referenced by the supplied path.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * @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.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, atime: TimeLike, mtime: TimeLike): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns `undefined`.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link utimes}.
|
|
|
+ * @since v0.4.2
|
|
|
+ */
|
|
|
+ function utimesSync(path: PathLike, atime: TimeLike, mtime: TimeLike): void;
|
|
|
+ /**
|
|
|
+ * Change the file system timestamps of the object referenced by the supplied file
|
|
|
+ * descriptor. See {@link utimes}.
|
|
|
+ * @since v0.4.2
|
|
|
+ */
|
|
|
+ function futimes(fd: number, atime: TimeLike, mtime: TimeLike, callback: NoParamCallback): void;
|
|
|
+ namespace futimes {
|
|
|
+ /**
|
|
|
+ * Asynchronously change file timestamps of the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @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.
|
|
|
+ */
|
|
|
+ function __promisify__(fd: number, atime: TimeLike, mtime: TimeLike): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronous version of {@link futimes}. Returns `undefined`.
|
|
|
+ * @since v0.4.2
|
|
|
+ */
|
|
|
+ function futimesSync(fd: number, atime: TimeLike, mtime: TimeLike): void;
|
|
|
+ /**
|
|
|
+ * Request that all data for the open file descriptor is flushed to the storage
|
|
|
+ * device. The specific implementation is operating system and device specific.
|
|
|
+ * Refer to the POSIX [`fsync(2)`](http://man7.org/linux/man-pages/man2/fsync.2.html) documentation for more detail. No arguments other
|
|
|
+ * than a possible exception are given to the completion callback.
|
|
|
+ * @since v0.1.96
|
|
|
+ */
|
|
|
+ function fsync(fd: number, callback: NoParamCallback): void;
|
|
|
+ namespace fsync {
|
|
|
+ /**
|
|
|
+ * Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ */
|
|
|
+ function __promisify__(fd: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Request that all data for the open file descriptor is flushed to the storage
|
|
|
+ * device. The specific implementation is operating system and device specific.
|
|
|
+ * Refer to the POSIX [`fsync(2)`](http://man7.org/linux/man-pages/man2/fsync.2.html) documentation for more detail. Returns `undefined`.
|
|
|
+ * @since v0.1.96
|
|
|
+ */
|
|
|
+ function fsyncSync(fd: number): void;
|
|
|
+ interface WriteOptions {
|
|
|
+ /**
|
|
|
+ * @default 0
|
|
|
+ */
|
|
|
+ offset?: number | undefined;
|
|
|
+ /**
|
|
|
+ * @default `buffer.byteLength - offset`
|
|
|
+ */
|
|
|
+ length?: number | undefined;
|
|
|
+ /**
|
|
|
+ * @default null
|
|
|
+ */
|
|
|
+ position?: number | null | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Write `buffer` to the file specified by `fd`.
|
|
|
+ *
|
|
|
+ * `offset` determines the part of the buffer to be written, and `length` is
|
|
|
+ * an integer specifying the number of bytes to write.
|
|
|
+ *
|
|
|
+ * `position` refers to the offset from the beginning of the file where this data
|
|
|
+ * should be written. If `typeof position !== 'number'`, the data will be written
|
|
|
+ * at the current position. See [`pwrite(2)`](http://man7.org/linux/man-pages/man2/pwrite.2.html).
|
|
|
+ *
|
|
|
+ * The callback will be given three arguments `(err, bytesWritten, buffer)` where `bytesWritten` specifies how many _bytes_ were written from `buffer`.
|
|
|
+ *
|
|
|
+ * If this method is invoked as its `util.promisify()` ed version, it returns
|
|
|
+ * a promise for an `Object` with `bytesWritten` and `buffer` properties.
|
|
|
+ *
|
|
|
+ * It is unsafe to use `fs.write()` multiple times on the same file without waiting
|
|
|
+ * for the callback. For this scenario, {@link createWriteStream} is
|
|
|
+ * recommended.
|
|
|
+ *
|
|
|
+ * On Linux, positional writes don't work when the file is opened in append mode.
|
|
|
+ * The kernel ignores the position argument and always appends the data to
|
|
|
+ * the end of the file.
|
|
|
+ * @since v0.0.2
|
|
|
+ * @param [offset=0]
|
|
|
+ * @param [length=buffer.byteLength - offset]
|
|
|
+ * @param [position='null']
|
|
|
+ */
|
|
|
+ function write<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ offset: number | undefined | null,
|
|
|
+ length: number | undefined | null,
|
|
|
+ position: number | undefined | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param offset The part of the buffer to be written. If not supplied, defaults to `0`.
|
|
|
+ * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`.
|
|
|
+ */
|
|
|
+ function write<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ offset: number | undefined | null,
|
|
|
+ length: number | undefined | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param offset The part of the buffer to be written. If not supplied, defaults to `0`.
|
|
|
+ */
|
|
|
+ function write<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ offset: number | undefined | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ */
|
|
|
+ function write<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param options An object with the following properties:
|
|
|
+ * * `offset` The part of the buffer to be written. If not supplied, defaults to `0`.
|
|
|
+ * * `length` The number of bytes to write. If not supplied, defaults to `buffer.length - offset`.
|
|
|
+ * * `position` The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
|
|
|
+ */
|
|
|
+ function write<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ options: WriteOptions,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, written: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `string` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param string A string to write.
|
|
|
+ * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
|
|
|
+ * @param encoding The expected string encoding.
|
|
|
+ */
|
|
|
+ function write(
|
|
|
+ fd: number,
|
|
|
+ string: string,
|
|
|
+ position: number | undefined | null,
|
|
|
+ encoding: BufferEncoding | undefined | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `string` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param string A string to write.
|
|
|
+ * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
|
|
|
+ */
|
|
|
+ function write(
|
|
|
+ fd: number,
|
|
|
+ string: string,
|
|
|
+ position: number | undefined | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `string` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param string A string to write.
|
|
|
+ */
|
|
|
+ function write(
|
|
|
+ fd: number,
|
|
|
+ string: string,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, written: number, str: string) => void,
|
|
|
+ ): void;
|
|
|
+ namespace write {
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param offset The part of the buffer to be written. If not supplied, defaults to `0`.
|
|
|
+ * @param length The number of bytes to write. If not supplied, defaults to `buffer.length - offset`.
|
|
|
+ * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
|
|
|
+ */
|
|
|
+ function __promisify__<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer?: TBuffer,
|
|
|
+ offset?: number,
|
|
|
+ length?: number,
|
|
|
+ position?: number | null,
|
|
|
+ ): Promise<{
|
|
|
+ bytesWritten: number;
|
|
|
+ buffer: TBuffer;
|
|
|
+ }>;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `buffer` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param options An object with the following properties:
|
|
|
+ * * `offset` The part of the buffer to be written. If not supplied, defaults to `0`.
|
|
|
+ * * `length` The number of bytes to write. If not supplied, defaults to `buffer.length - offset`.
|
|
|
+ * * `position` The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
|
|
|
+ */
|
|
|
+ function __promisify__<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer?: TBuffer,
|
|
|
+ options?: WriteOptions,
|
|
|
+ ): Promise<{
|
|
|
+ bytesWritten: number;
|
|
|
+ buffer: TBuffer;
|
|
|
+ }>;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes `string` to the file referenced by the supplied file descriptor.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param string A string to write.
|
|
|
+ * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
|
|
|
+ * @param encoding The expected string encoding.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ fd: number,
|
|
|
+ string: string,
|
|
|
+ position?: number | null,
|
|
|
+ encoding?: BufferEncoding | null,
|
|
|
+ ): Promise<{
|
|
|
+ bytesWritten: number;
|
|
|
+ buffer: string;
|
|
|
+ }>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link write}.
|
|
|
+ * @since v0.1.21
|
|
|
+ * @param [offset=0]
|
|
|
+ * @param [length=buffer.byteLength - offset]
|
|
|
+ * @param [position='null']
|
|
|
+ * @return The number of bytes written.
|
|
|
+ */
|
|
|
+ function writeSync(
|
|
|
+ fd: number,
|
|
|
+ buffer: NodeJS.ArrayBufferView,
|
|
|
+ offset?: number | null,
|
|
|
+ length?: number | null,
|
|
|
+ position?: number | null,
|
|
|
+ ): number;
|
|
|
+ /**
|
|
|
+ * Synchronously writes `string` to the file referenced by the supplied file descriptor, returning the number of bytes written.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @param string A string to write.
|
|
|
+ * @param position The offset from the beginning of the file where this data should be written. If not supplied, defaults to the current position.
|
|
|
+ * @param encoding The expected string encoding.
|
|
|
+ */
|
|
|
+ function writeSync(
|
|
|
+ fd: number,
|
|
|
+ string: string,
|
|
|
+ position?: number | null,
|
|
|
+ encoding?: BufferEncoding | null,
|
|
|
+ ): number;
|
|
|
+ type ReadPosition = number | bigint;
|
|
|
+ interface ReadOptions {
|
|
|
+ /**
|
|
|
+ * @default 0
|
|
|
+ */
|
|
|
+ offset?: number | undefined;
|
|
|
+ /**
|
|
|
+ * @default `length of buffer`
|
|
|
+ */
|
|
|
+ length?: number | undefined;
|
|
|
+ /**
|
|
|
+ * @default null
|
|
|
+ */
|
|
|
+ position?: ReadPosition | null | undefined;
|
|
|
+ }
|
|
|
+ interface ReadOptionsWithBuffer<T extends NodeJS.ArrayBufferView> extends ReadOptions {
|
|
|
+ buffer?: T | undefined;
|
|
|
+ }
|
|
|
+ /** @deprecated Use `ReadOptions` instead. */
|
|
|
+ // TODO: remove in future major
|
|
|
+ interface ReadSyncOptions extends ReadOptions {}
|
|
|
+ /** @deprecated Use `ReadOptionsWithBuffer` instead. */
|
|
|
+ // TODO: remove in future major
|
|
|
+ interface ReadAsyncOptions<T extends NodeJS.ArrayBufferView> extends ReadOptionsWithBuffer<T> {}
|
|
|
+ /**
|
|
|
+ * Read data from the file specified by `fd`.
|
|
|
+ *
|
|
|
+ * The callback is given the three arguments, `(err, bytesRead, buffer)`.
|
|
|
+ *
|
|
|
+ * If the file is not modified concurrently, the end-of-file is reached when the
|
|
|
+ * number of bytes read is zero.
|
|
|
+ *
|
|
|
+ * If this method is invoked as its `util.promisify()` ed version, it returns
|
|
|
+ * a promise for an `Object` with `bytesRead` and `buffer` properties.
|
|
|
+ * @since v0.0.2
|
|
|
+ * @param buffer The buffer that the data will be written to.
|
|
|
+ * @param offset The position in `buffer` to write the data to.
|
|
|
+ * @param length The number of bytes to read.
|
|
|
+ * @param position Specifies where to begin reading from in the file. If `position` is `null` or `-1 `, data will be read from the current file position, and the file position will be updated. If
|
|
|
+ * `position` is an integer, the file position will be unchanged.
|
|
|
+ */
|
|
|
+ function read<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ offset: number,
|
|
|
+ length: number,
|
|
|
+ position: ReadPosition | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Similar to the above `fs.read` function, this version takes an optional `options` object.
|
|
|
+ * If not otherwise specified in an `options` object,
|
|
|
+ * `buffer` defaults to `Buffer.alloc(16384)`,
|
|
|
+ * `offset` defaults to `0`,
|
|
|
+ * `length` defaults to `buffer.byteLength`, `- offset` as of Node 17.6.0
|
|
|
+ * `position` defaults to `null`
|
|
|
+ * @since v12.17.0, 13.11.0
|
|
|
+ */
|
|
|
+ function read<TBuffer extends NodeJS.ArrayBufferView = NonSharedBuffer>(
|
|
|
+ fd: number,
|
|
|
+ options: ReadOptionsWithBuffer<TBuffer>,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ function read<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ options: ReadOptions,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ function read<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: TBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ function read(
|
|
|
+ fd: number,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, bytesRead: number, buffer: NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ namespace read {
|
|
|
+ /**
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ * @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.
|
|
|
+ */
|
|
|
+ function __promisify__<TBuffer extends NodeJS.ArrayBufferView>(
|
|
|
+ fd: number,
|
|
|
+ buffer: TBuffer,
|
|
|
+ offset: number,
|
|
|
+ length: number,
|
|
|
+ position: ReadPosition | null,
|
|
|
+ ): Promise<{
|
|
|
+ bytesRead: number;
|
|
|
+ buffer: TBuffer;
|
|
|
+ }>;
|
|
|
+ function __promisify__<TBuffer extends NodeJS.ArrayBufferView = NonSharedBuffer>(
|
|
|
+ fd: number,
|
|
|
+ options: ReadOptionsWithBuffer<TBuffer>,
|
|
|
+ ): Promise<{
|
|
|
+ bytesRead: number;
|
|
|
+ buffer: TBuffer;
|
|
|
+ }>;
|
|
|
+ function __promisify__(fd: number): Promise<{
|
|
|
+ bytesRead: number;
|
|
|
+ buffer: NonSharedBuffer;
|
|
|
+ }>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns the number of `bytesRead`.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link read}.
|
|
|
+ * @since v0.1.21
|
|
|
+ * @param [position='null']
|
|
|
+ */
|
|
|
+ function readSync(
|
|
|
+ fd: number,
|
|
|
+ buffer: NodeJS.ArrayBufferView,
|
|
|
+ offset: number,
|
|
|
+ length: number,
|
|
|
+ position: ReadPosition | null,
|
|
|
+ ): number;
|
|
|
+ /**
|
|
|
+ * Similar to the above `fs.readSync` function, this version takes an optional `options` object.
|
|
|
+ * If no `options` object is specified, it will default with the above values.
|
|
|
+ */
|
|
|
+ function readSync(fd: number, buffer: NodeJS.ArrayBufferView, opts?: ReadOptions): number;
|
|
|
+ /**
|
|
|
+ * Asynchronously reads the entire contents of a file.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { readFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * readFile('/etc/passwd', (err, data) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log(data);
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The callback is passed two arguments `(err, data)`, where `data` is the
|
|
|
+ * contents of the file.
|
|
|
+ *
|
|
|
+ * If no encoding is specified, then the raw buffer is returned.
|
|
|
+ *
|
|
|
+ * If `options` is a string, then it specifies the encoding:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { readFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * readFile('/etc/passwd', 'utf8', callback);
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * When the path is a directory, the behavior of `fs.readFile()` and {@link readFileSync} is platform-specific. On macOS, Linux, and Windows, an
|
|
|
+ * error will be returned. On FreeBSD, a representation of the directory's contents
|
|
|
+ * will be returned.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { readFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * // macOS, Linux, and Windows
|
|
|
+ * readFile('<directory>', (err, data) => {
|
|
|
+ * // => [Error: EISDIR: illegal operation on a directory, read <directory>]
|
|
|
+ * });
|
|
|
+ *
|
|
|
+ * // FreeBSD
|
|
|
+ * readFile('<directory>', (err, data) => {
|
|
|
+ * // => null, <data>
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * It is possible to abort an ongoing request using an `AbortSignal`. If a
|
|
|
+ * request is aborted the callback is called with an `AbortError`:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { readFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * const controller = new AbortController();
|
|
|
+ * const signal = controller.signal;
|
|
|
+ * readFile(fileInfo[0].name, { signal }, (err, buf) => {
|
|
|
+ * // ...
|
|
|
+ * });
|
|
|
+ * // When you want to abort the request
|
|
|
+ * controller.abort();
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The `fs.readFile()` function buffers the entire file. To minimize memory costs,
|
|
|
+ * when possible prefer streaming via `fs.createReadStream()`.
|
|
|
+ *
|
|
|
+ * Aborting an ongoing request does not abort individual operating
|
|
|
+ * system requests but rather the internal buffering `fs.readFile` performs.
|
|
|
+ * @since v0.1.29
|
|
|
+ * @param path filename or file descriptor
|
|
|
+ */
|
|
|
+ function readFile(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options:
|
|
|
+ | ({
|
|
|
+ encoding?: null | undefined;
|
|
|
+ flag?: string | undefined;
|
|
|
+ } & Abortable)
|
|
|
+ | undefined
|
|
|
+ | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, data: NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously reads the entire contents of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag.
|
|
|
+ * If a flag is not provided, it defaults to `'r'`.
|
|
|
+ */
|
|
|
+ function readFile(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options:
|
|
|
+ | ({
|
|
|
+ encoding: BufferEncoding;
|
|
|
+ flag?: string | undefined;
|
|
|
+ } & Abortable)
|
|
|
+ | BufferEncoding,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, data: string) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously reads the entire contents of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag.
|
|
|
+ * If a flag is not provided, it defaults to `'r'`.
|
|
|
+ */
|
|
|
+ function readFile(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options:
|
|
|
+ | (ObjectEncodingOptions & {
|
|
|
+ flag?: string | undefined;
|
|
|
+ } & Abortable)
|
|
|
+ | BufferEncoding
|
|
|
+ | undefined
|
|
|
+ | null,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, data: string | NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously reads the entire contents of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ */
|
|
|
+ function readFile(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, data: NonSharedBuffer) => void,
|
|
|
+ ): void;
|
|
|
+ namespace readFile {
|
|
|
+ /**
|
|
|
+ * Asynchronously reads the entire contents of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param options An object that may contain an optional flag.
|
|
|
+ * If a flag is not provided, it defaults to `'r'`.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options?: {
|
|
|
+ encoding?: null | undefined;
|
|
|
+ flag?: string | undefined;
|
|
|
+ } | null,
|
|
|
+ ): Promise<NonSharedBuffer>;
|
|
|
+ /**
|
|
|
+ * Asynchronously reads the entire contents of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * URL support is _experimental_.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag.
|
|
|
+ * If a flag is not provided, it defaults to `'r'`.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options:
|
|
|
+ | {
|
|
|
+ encoding: BufferEncoding;
|
|
|
+ flag?: string | undefined;
|
|
|
+ }
|
|
|
+ | BufferEncoding,
|
|
|
+ ): Promise<string>;
|
|
|
+ /**
|
|
|
+ * Asynchronously reads the entire contents of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * URL support is _experimental_.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag.
|
|
|
+ * If a flag is not provided, it defaults to `'r'`.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options?:
|
|
|
+ | (ObjectEncodingOptions & {
|
|
|
+ flag?: string | undefined;
|
|
|
+ })
|
|
|
+ | BufferEncoding
|
|
|
+ | null,
|
|
|
+ ): Promise<string | NonSharedBuffer>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns the contents of the `path`.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link readFile}.
|
|
|
+ *
|
|
|
+ * If the `encoding` option is specified then this function returns a
|
|
|
+ * string. Otherwise it returns a buffer.
|
|
|
+ *
|
|
|
+ * Similar to {@link readFile}, when the path is a directory, the behavior of `fs.readFileSync()` is platform-specific.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { readFileSync } from 'node:fs';
|
|
|
+ *
|
|
|
+ * // macOS, Linux, and Windows
|
|
|
+ * readFileSync('<directory>');
|
|
|
+ * // => [Error: EISDIR: illegal operation on a directory, read <directory>]
|
|
|
+ *
|
|
|
+ * // FreeBSD
|
|
|
+ * readFileSync('<directory>'); // => <data>
|
|
|
+ * ```
|
|
|
+ * @since v0.1.8
|
|
|
+ * @param path filename or file descriptor
|
|
|
+ */
|
|
|
+ function readFileSync(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options?: {
|
|
|
+ encoding?: null | undefined;
|
|
|
+ flag?: string | undefined;
|
|
|
+ } | null,
|
|
|
+ ): NonSharedBuffer;
|
|
|
+ /**
|
|
|
+ * Synchronously reads the entire contents of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag.
|
|
|
+ * If a flag is not provided, it defaults to `'r'`.
|
|
|
+ */
|
|
|
+ function readFileSync(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options:
|
|
|
+ | {
|
|
|
+ encoding: BufferEncoding;
|
|
|
+ flag?: string | undefined;
|
|
|
+ }
|
|
|
+ | BufferEncoding,
|
|
|
+ ): string;
|
|
|
+ /**
|
|
|
+ * Synchronously reads the entire contents of a file.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param options Either the encoding for the result, or an object that contains the encoding and an optional flag.
|
|
|
+ * If a flag is not provided, it defaults to `'r'`.
|
|
|
+ */
|
|
|
+ function readFileSync(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ options?:
|
|
|
+ | (ObjectEncodingOptions & {
|
|
|
+ flag?: string | undefined;
|
|
|
+ })
|
|
|
+ | BufferEncoding
|
|
|
+ | null,
|
|
|
+ ): string | NonSharedBuffer;
|
|
|
+ type WriteFileOptions =
|
|
|
+ | (
|
|
|
+ & ObjectEncodingOptions
|
|
|
+ & Abortable
|
|
|
+ & {
|
|
|
+ mode?: Mode | undefined;
|
|
|
+ flag?: string | undefined;
|
|
|
+ flush?: boolean | undefined;
|
|
|
+ }
|
|
|
+ )
|
|
|
+ | BufferEncoding
|
|
|
+ | null;
|
|
|
+ /**
|
|
|
+ * When `file` is a filename, asynchronously writes data to the file, replacing the
|
|
|
+ * file if it already exists. `data` can be a string or a buffer.
|
|
|
+ *
|
|
|
+ * When `file` is a file descriptor, the behavior is similar to calling `fs.write()` directly (which is recommended). See the notes below on using
|
|
|
+ * a file descriptor.
|
|
|
+ *
|
|
|
+ * The `encoding` option is ignored if `data` is a buffer.
|
|
|
+ *
|
|
|
+ * The `mode` option only affects the newly created file. See {@link open} for more details.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { writeFile } from 'node:fs';
|
|
|
+ * import { Buffer } from 'node:buffer';
|
|
|
+ *
|
|
|
+ * const data = new Uint8Array(Buffer.from('Hello Node.js'));
|
|
|
+ * writeFile('message.txt', data, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log('The file has been saved!');
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * If `options` is a string, then it specifies the encoding:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { writeFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * writeFile('message.txt', 'Hello Node.js', 'utf8', callback);
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * It is unsafe to use `fs.writeFile()` multiple times on the same file without
|
|
|
+ * waiting for the callback. For this scenario, {@link createWriteStream} is
|
|
|
+ * recommended.
|
|
|
+ *
|
|
|
+ * Similarly to `fs.readFile` \- `fs.writeFile` is a convenience method that
|
|
|
+ * performs multiple `write` calls internally to write the buffer passed to it.
|
|
|
+ * For performance sensitive code consider using {@link createWriteStream}.
|
|
|
+ *
|
|
|
+ * It is possible to use an `AbortSignal` to cancel an `fs.writeFile()`.
|
|
|
+ * Cancelation is "best effort", and some amount of data is likely still
|
|
|
+ * to be written.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { writeFile } from 'node:fs';
|
|
|
+ * import { Buffer } from 'node:buffer';
|
|
|
+ *
|
|
|
+ * const controller = new AbortController();
|
|
|
+ * const { signal } = controller;
|
|
|
+ * const data = new Uint8Array(Buffer.from('Hello Node.js'));
|
|
|
+ * writeFile('message.txt', data, { signal }, (err) => {
|
|
|
+ * // When a request is aborted - the callback is called with an AbortError
|
|
|
+ * });
|
|
|
+ * // When the request should be aborted
|
|
|
+ * controller.abort();
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * Aborting an ongoing request does not abort individual operating
|
|
|
+ * system requests but rather the internal buffering `fs.writeFile` performs.
|
|
|
+ * @since v0.1.29
|
|
|
+ * @param file filename or file descriptor
|
|
|
+ */
|
|
|
+ function writeFile(
|
|
|
+ file: PathOrFileDescriptor,
|
|
|
+ data: string | NodeJS.ArrayBufferView,
|
|
|
+ options: WriteFileOptions,
|
|
|
+ callback: NoParamCallback,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously writes data to a file, replacing the file if it already exists.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.
|
|
|
+ */
|
|
|
+ function writeFile(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ data: string | NodeJS.ArrayBufferView,
|
|
|
+ callback: NoParamCallback,
|
|
|
+ ): void;
|
|
|
+ namespace writeFile {
|
|
|
+ /**
|
|
|
+ * Asynchronously writes data to a file, replacing the file if it already exists.
|
|
|
+ * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * URL support is _experimental_.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @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.
|
|
|
+ * If `encoding` is not supplied, the default of `'utf8'` is used.
|
|
|
+ * If `mode` is not supplied, the default of `0o666` is used.
|
|
|
+ * If `mode` is a string, it is parsed as an octal integer.
|
|
|
+ * If `flag` is not supplied, the default of `'w'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ data: string | NodeJS.ArrayBufferView,
|
|
|
+ options?: WriteFileOptions,
|
|
|
+ ): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns `undefined`.
|
|
|
+ *
|
|
|
+ * The `mode` option only affects the newly created file. See {@link open} for more details.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link writeFile}.
|
|
|
+ * @since v0.1.29
|
|
|
+ * @param file filename or file descriptor
|
|
|
+ */
|
|
|
+ function writeFileSync(
|
|
|
+ file: PathOrFileDescriptor,
|
|
|
+ data: string | NodeJS.ArrayBufferView,
|
|
|
+ options?: WriteFileOptions,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously append data to a file, creating the file if it does not yet
|
|
|
+ * exist. `data` can be a string or a `Buffer`.
|
|
|
+ *
|
|
|
+ * The `mode` option only affects the newly created file. See {@link open} for more details.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { appendFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * appendFile('message.txt', 'data to append', (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log('The "data to append" was appended to file!');
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * If `options` is a string, then it specifies the encoding:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { appendFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * appendFile('message.txt', 'data to append', 'utf8', callback);
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The `path` may be specified as a numeric file descriptor that has been opened
|
|
|
+ * for appending (using `fs.open()` or `fs.openSync()`). The file descriptor will
|
|
|
+ * not be closed automatically.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { open, close, appendFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * function closeFd(fd) {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * open('message.txt', 'a', (err, fd) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * appendFile(fd, 'data to append', 'utf8', (err) => {
|
|
|
+ * closeFd(fd);
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * } catch (err) {
|
|
|
+ * closeFd(fd);
|
|
|
+ * throw err;
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ * @since v0.6.7
|
|
|
+ * @param path filename or file descriptor
|
|
|
+ */
|
|
|
+ function appendFile(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ data: string | Uint8Array,
|
|
|
+ options: WriteFileOptions,
|
|
|
+ callback: NoParamCallback,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously append data to a file, creating the file if it does not exist.
|
|
|
+ * @param file A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @param data The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.
|
|
|
+ */
|
|
|
+ function appendFile(file: PathOrFileDescriptor, data: string | Uint8Array, callback: NoParamCallback): void;
|
|
|
+ namespace appendFile {
|
|
|
+ /**
|
|
|
+ * Asynchronously append data to a file, creating the file if it does not exist.
|
|
|
+ * @param file A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * URL support is _experimental_.
|
|
|
+ * If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
|
+ * @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.
|
|
|
+ * If `encoding` is not supplied, the default of `'utf8'` is used.
|
|
|
+ * If `mode` is not supplied, the default of `0o666` is used.
|
|
|
+ * If `mode` is a string, it is parsed as an octal integer.
|
|
|
+ * If `flag` is not supplied, the default of `'a'` is used.
|
|
|
+ */
|
|
|
+ function __promisify__(
|
|
|
+ file: PathOrFileDescriptor,
|
|
|
+ data: string | Uint8Array,
|
|
|
+ options?: WriteFileOptions,
|
|
|
+ ): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronously append data to a file, creating the file if it does not yet
|
|
|
+ * exist. `data` can be a string or a `Buffer`.
|
|
|
+ *
|
|
|
+ * The `mode` option only affects the newly created file. See {@link open} for more details.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { appendFileSync } from 'node:fs';
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * appendFileSync('message.txt', 'data to append');
|
|
|
+ * console.log('The "data to append" was appended to file!');
|
|
|
+ * } catch (err) {
|
|
|
+ * // Handle the error
|
|
|
+ * }
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * If `options` is a string, then it specifies the encoding:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { appendFileSync } from 'node:fs';
|
|
|
+ *
|
|
|
+ * appendFileSync('message.txt', 'data to append', 'utf8');
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The `path` may be specified as a numeric file descriptor that has been opened
|
|
|
+ * for appending (using `fs.open()` or `fs.openSync()`). The file descriptor will
|
|
|
+ * not be closed automatically.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { openSync, closeSync, appendFileSync } from 'node:fs';
|
|
|
+ *
|
|
|
+ * let fd;
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * fd = openSync('message.txt', 'a');
|
|
|
+ * appendFileSync(fd, 'data to append', 'utf8');
|
|
|
+ * } catch (err) {
|
|
|
+ * // Handle the error
|
|
|
+ * } finally {
|
|
|
+ * if (fd !== undefined)
|
|
|
+ * closeSync(fd);
|
|
|
+ * }
|
|
|
+ * ```
|
|
|
+ * @since v0.6.7
|
|
|
+ * @param path filename or file descriptor
|
|
|
+ */
|
|
|
+ function appendFileSync(
|
|
|
+ path: PathOrFileDescriptor,
|
|
|
+ data: string | Uint8Array,
|
|
|
+ options?: WriteFileOptions,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Watch for changes on `filename`. The callback `listener` will be called each
|
|
|
+ * time the file is accessed.
|
|
|
+ *
|
|
|
+ * The `options` argument may be omitted. If provided, it should be an object. The `options` object may contain a boolean named `persistent` that indicates
|
|
|
+ * whether the process should continue to run as long as files are being watched.
|
|
|
+ * The `options` object may specify an `interval` property indicating how often the
|
|
|
+ * target should be polled in milliseconds.
|
|
|
+ *
|
|
|
+ * The `listener` gets two arguments the current stat object and the previous
|
|
|
+ * stat object:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { watchFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * watchFile('message.text', (curr, prev) => {
|
|
|
+ * console.log(`the current mtime is: ${curr.mtime}`);
|
|
|
+ * console.log(`the previous mtime was: ${prev.mtime}`);
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * These stat objects are instances of `fs.Stat`. If the `bigint` option is `true`,
|
|
|
+ * the numeric values in these objects are specified as `BigInt`s.
|
|
|
+ *
|
|
|
+ * To be notified when the file was modified, not just accessed, it is necessary
|
|
|
+ * to compare `curr.mtimeMs` and `prev.mtimeMs`.
|
|
|
+ *
|
|
|
+ * When an `fs.watchFile` operation results in an `ENOENT` error, it
|
|
|
+ * will invoke the listener once, with all the fields zeroed (or, for dates, the
|
|
|
+ * Unix Epoch). If the file is created later on, the listener will be called
|
|
|
+ * again, with the latest stat objects. This is a change in functionality since
|
|
|
+ * v0.10.
|
|
|
+ *
|
|
|
+ * Using {@link watch} is more efficient than `fs.watchFile` and `fs.unwatchFile`. `fs.watch` should be used instead of `fs.watchFile` and `fs.unwatchFile` when possible.
|
|
|
+ *
|
|
|
+ * When a file being watched by `fs.watchFile()` disappears and reappears,
|
|
|
+ * then the contents of `previous` in the second callback event (the file's
|
|
|
+ * reappearance) will be the same as the contents of `previous` in the first
|
|
|
+ * callback event (its disappearance).
|
|
|
+ *
|
|
|
+ * This happens when:
|
|
|
+ *
|
|
|
+ * * the file is deleted, followed by a restore
|
|
|
+ * * the file is renamed and then renamed a second time back to its original name
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ interface WatchFileOptions {
|
|
|
+ bigint?: boolean | undefined;
|
|
|
+ persistent?: boolean | undefined;
|
|
|
+ interval?: number | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Watch for changes on `filename`. The callback `listener` will be called each
|
|
|
+ * time the file is accessed.
|
|
|
+ *
|
|
|
+ * The `options` argument may be omitted. If provided, it should be an object. The `options` object may contain a boolean named `persistent` that indicates
|
|
|
+ * whether the process should continue to run as long as files are being watched.
|
|
|
+ * The `options` object may specify an `interval` property indicating how often the
|
|
|
+ * target should be polled in milliseconds.
|
|
|
+ *
|
|
|
+ * The `listener` gets two arguments the current stat object and the previous
|
|
|
+ * stat object:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { watchFile } from 'node:fs';
|
|
|
+ *
|
|
|
+ * watchFile('message.text', (curr, prev) => {
|
|
|
+ * console.log(`the current mtime is: ${curr.mtime}`);
|
|
|
+ * console.log(`the previous mtime was: ${prev.mtime}`);
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * These stat objects are instances of `fs.Stat`. If the `bigint` option is `true`,
|
|
|
+ * the numeric values in these objects are specified as `BigInt`s.
|
|
|
+ *
|
|
|
+ * To be notified when the file was modified, not just accessed, it is necessary
|
|
|
+ * to compare `curr.mtimeMs` and `prev.mtimeMs`.
|
|
|
+ *
|
|
|
+ * When an `fs.watchFile` operation results in an `ENOENT` error, it
|
|
|
+ * will invoke the listener once, with all the fields zeroed (or, for dates, the
|
|
|
+ * Unix Epoch). If the file is created later on, the listener will be called
|
|
|
+ * again, with the latest stat objects. This is a change in functionality since
|
|
|
+ * v0.10.
|
|
|
+ *
|
|
|
+ * Using {@link watch} is more efficient than `fs.watchFile` and `fs.unwatchFile`. `fs.watch` should be used instead of `fs.watchFile` and `fs.unwatchFile` when possible.
|
|
|
+ *
|
|
|
+ * When a file being watched by `fs.watchFile()` disappears and reappears,
|
|
|
+ * then the contents of `previous` in the second callback event (the file's
|
|
|
+ * reappearance) will be the same as the contents of `previous` in the first
|
|
|
+ * callback event (its disappearance).
|
|
|
+ *
|
|
|
+ * This happens when:
|
|
|
+ *
|
|
|
+ * * the file is deleted, followed by a restore
|
|
|
+ * * the file is renamed and then renamed a second time back to its original name
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function watchFile(
|
|
|
+ filename: PathLike,
|
|
|
+ options:
|
|
|
+ | (WatchFileOptions & {
|
|
|
+ bigint?: false | undefined;
|
|
|
+ })
|
|
|
+ | undefined,
|
|
|
+ listener: StatsListener,
|
|
|
+ ): StatWatcher;
|
|
|
+ function watchFile(
|
|
|
+ filename: PathLike,
|
|
|
+ options:
|
|
|
+ | (WatchFileOptions & {
|
|
|
+ bigint: true;
|
|
|
+ })
|
|
|
+ | undefined,
|
|
|
+ listener: BigIntStatsListener,
|
|
|
+ ): StatWatcher;
|
|
|
+ /**
|
|
|
+ * Watch for changes on `filename`. The callback `listener` will be called each time the file is accessed.
|
|
|
+ * @param filename A path to a file or directory. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function watchFile(filename: PathLike, listener: StatsListener): StatWatcher;
|
|
|
+ /**
|
|
|
+ * Stop watching for changes on `filename`. If `listener` is specified, only that
|
|
|
+ * particular listener is removed. Otherwise, _all_ listeners are removed,
|
|
|
+ * effectively stopping watching of `filename`.
|
|
|
+ *
|
|
|
+ * Calling `fs.unwatchFile()` with a filename that is not being watched is a
|
|
|
+ * no-op, not an error.
|
|
|
+ *
|
|
|
+ * Using {@link watch} is more efficient than `fs.watchFile()` and `fs.unwatchFile()`. `fs.watch()` should be used instead of `fs.watchFile()` and `fs.unwatchFile()` when possible.
|
|
|
+ * @since v0.1.31
|
|
|
+ * @param listener Optional, a listener previously attached using `fs.watchFile()`
|
|
|
+ */
|
|
|
+ function unwatchFile(filename: PathLike, listener?: StatsListener): void;
|
|
|
+ function unwatchFile(filename: PathLike, listener?: BigIntStatsListener): void;
|
|
|
+ type WatchIgnorePredicate = string | RegExp | ((filename: string) => boolean);
|
|
|
+ interface WatchOptions extends Abortable {
|
|
|
+ encoding?: BufferEncoding | "buffer" | undefined;
|
|
|
+ persistent?: boolean | undefined;
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ ignore?: WatchIgnorePredicate | readonly WatchIgnorePredicate[] | undefined;
|
|
|
+ }
|
|
|
+ interface WatchOptionsWithBufferEncoding extends WatchOptions {
|
|
|
+ encoding: "buffer";
|
|
|
+ }
|
|
|
+ interface WatchOptionsWithStringEncoding extends WatchOptions {
|
|
|
+ encoding?: BufferEncoding | undefined;
|
|
|
+ }
|
|
|
+ type WatchEventType = "rename" | "change";
|
|
|
+ type WatchListener<T> = (event: WatchEventType, filename: T | null) => void;
|
|
|
+ type StatsListener = (curr: Stats, prev: Stats) => void;
|
|
|
+ type BigIntStatsListener = (curr: BigIntStats, prev: BigIntStats) => void;
|
|
|
+ /**
|
|
|
+ * Watch for changes on `filename`, where `filename` is either a file or a
|
|
|
+ * directory.
|
|
|
+ *
|
|
|
+ * The second argument is optional. If `options` is provided as a string, it
|
|
|
+ * specifies the `encoding`. Otherwise `options` should be passed as an object.
|
|
|
+ *
|
|
|
+ * The listener callback gets two arguments `(eventType, filename)`. `eventType`is either `'rename'` or `'change'`, and `filename` is the name of the file
|
|
|
+ * which triggered the event.
|
|
|
+ *
|
|
|
+ * On most platforms, `'rename'` is emitted whenever a filename appears or
|
|
|
+ * disappears in the directory.
|
|
|
+ *
|
|
|
+ * The listener callback is attached to the `'change'` event fired by `fs.FSWatcher`, but it is not the same thing as the `'change'` value of `eventType`.
|
|
|
+ *
|
|
|
+ * If a `signal` is passed, aborting the corresponding AbortController will close
|
|
|
+ * the returned `fs.FSWatcher`.
|
|
|
+ * @since v0.5.10
|
|
|
+ * @param listener
|
|
|
+ */
|
|
|
+ function watch(
|
|
|
+ filename: PathLike,
|
|
|
+ options?: WatchOptionsWithStringEncoding | BufferEncoding | null,
|
|
|
+ listener?: WatchListener<string>,
|
|
|
+ ): FSWatcher;
|
|
|
+ function watch(
|
|
|
+ filename: PathLike,
|
|
|
+ options: WatchOptionsWithBufferEncoding | "buffer",
|
|
|
+ listener: WatchListener<NonSharedBuffer>,
|
|
|
+ ): FSWatcher;
|
|
|
+ function watch(
|
|
|
+ filename: PathLike,
|
|
|
+ options: WatchOptions | BufferEncoding | "buffer" | null,
|
|
|
+ listener: WatchListener<string | NonSharedBuffer>,
|
|
|
+ ): FSWatcher;
|
|
|
+ function watch(filename: PathLike, listener: WatchListener<string>): FSWatcher;
|
|
|
+ /**
|
|
|
+ * Test whether or not the given path exists by checking with the file system.
|
|
|
+ * Then call the `callback` argument with either true or false:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { exists } from 'node:fs';
|
|
|
+ *
|
|
|
+ * exists('/etc/passwd', (e) => {
|
|
|
+ * console.log(e ? 'it exists' : 'no passwd!');
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * **The parameters for this callback are not consistent with other Node.js**
|
|
|
+ * **callbacks.** Normally, the first parameter to a Node.js callback is an `err` parameter, optionally followed by other parameters. The `fs.exists()` callback
|
|
|
+ * has only one boolean parameter. This is one reason `fs.access()` is recommended
|
|
|
+ * instead of `fs.exists()`.
|
|
|
+ *
|
|
|
+ * Using `fs.exists()` to check for the existence of a file before calling `fs.open()`, `fs.readFile()`, or `fs.writeFile()` is not recommended. Doing
|
|
|
+ * so introduces a race condition, since other processes may change the file's
|
|
|
+ * state between the two calls. Instead, user code should open/read/write the
|
|
|
+ * file directly and handle the error raised if the file does not exist.
|
|
|
+ *
|
|
|
+ * **write (NOT RECOMMENDED)**
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { exists, open, close } from 'node:fs';
|
|
|
+ *
|
|
|
+ * exists('myfile', (e) => {
|
|
|
+ * if (e) {
|
|
|
+ * console.error('myfile already exists');
|
|
|
+ * } else {
|
|
|
+ * open('myfile', 'wx', (err, fd) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * writeMyData(fd);
|
|
|
+ * } finally {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * **write (RECOMMENDED)**
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { open, close } from 'node:fs';
|
|
|
+ * open('myfile', 'wx', (err, fd) => {
|
|
|
+ * if (err) {
|
|
|
+ * if (err.code === 'EEXIST') {
|
|
|
+ * console.error('myfile already exists');
|
|
|
+ * return;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * throw err;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * writeMyData(fd);
|
|
|
+ * } finally {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * **read (NOT RECOMMENDED)**
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { open, close, exists } from 'node:fs';
|
|
|
+ *
|
|
|
+ * exists('myfile', (e) => {
|
|
|
+ * if (e) {
|
|
|
+ * open('myfile', 'r', (err, fd) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * readMyData(fd);
|
|
|
+ * } finally {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * } else {
|
|
|
+ * console.error('myfile does not exist');
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * **read (RECOMMENDED)**
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { open, close } from 'node:fs';
|
|
|
+ *
|
|
|
+ * open('myfile', 'r', (err, fd) => {
|
|
|
+ * if (err) {
|
|
|
+ * if (err.code === 'ENOENT') {
|
|
|
+ * console.error('myfile does not exist');
|
|
|
+ * return;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * throw err;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * readMyData(fd);
|
|
|
+ * } finally {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The "not recommended" examples above check for existence and then use the
|
|
|
+ * file; the "recommended" examples are better because they use the file directly
|
|
|
+ * and handle the error, if any.
|
|
|
+ *
|
|
|
+ * In general, check for the existence of a file only if the file won't be
|
|
|
+ * used directly, for example when its existence is a signal from another
|
|
|
+ * process.
|
|
|
+ * @since v0.0.2
|
|
|
+ * @deprecated Since v1.0.0 - Use {@link stat} or {@link access} instead.
|
|
|
+ */
|
|
|
+ function exists(path: PathLike, callback: (exists: boolean) => void): void;
|
|
|
+ /** @deprecated */
|
|
|
+ namespace exists {
|
|
|
+ /**
|
|
|
+ * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * URL support is _experimental_.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike): Promise<boolean>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Returns `true` if the path exists, `false` otherwise.
|
|
|
+ *
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link exists}.
|
|
|
+ *
|
|
|
+ * `fs.exists()` is deprecated, but `fs.existsSync()` is not. The `callback` parameter to `fs.exists()` accepts parameters that are inconsistent with other
|
|
|
+ * Node.js callbacks. `fs.existsSync()` does not use a callback.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { existsSync } from 'node:fs';
|
|
|
+ *
|
|
|
+ * if (existsSync('/etc/passwd'))
|
|
|
+ * console.log('The path exists.');
|
|
|
+ * ```
|
|
|
+ * @since v0.1.21
|
|
|
+ */
|
|
|
+ function existsSync(path: PathLike): boolean;
|
|
|
+ namespace constants {
|
|
|
+ // File Access Constants
|
|
|
+ /** Constant for fs.access(). File is visible to the calling process. */
|
|
|
+ const F_OK: number;
|
|
|
+ /** Constant for fs.access(). File can be read by the calling process. */
|
|
|
+ const R_OK: number;
|
|
|
+ /** Constant for fs.access(). File can be written by the calling process. */
|
|
|
+ const W_OK: number;
|
|
|
+ /** Constant for fs.access(). File can be executed by the calling process. */
|
|
|
+ const X_OK: number;
|
|
|
+ // File Copy Constants
|
|
|
+ /** Constant for fs.copyFile. Flag indicating the destination file should not be overwritten if it already exists. */
|
|
|
+ const COPYFILE_EXCL: number;
|
|
|
+ /**
|
|
|
+ * Constant for fs.copyFile. copy operation will attempt to create a copy-on-write reflink.
|
|
|
+ * If the underlying platform does not support copy-on-write, then a fallback copy mechanism is used.
|
|
|
+ */
|
|
|
+ const COPYFILE_FICLONE: number;
|
|
|
+ /**
|
|
|
+ * Constant for fs.copyFile. Copy operation will attempt to create a copy-on-write reflink.
|
|
|
+ * If the underlying platform does not support copy-on-write, then the operation will fail with an error.
|
|
|
+ */
|
|
|
+ const COPYFILE_FICLONE_FORCE: number;
|
|
|
+ // File Open Constants
|
|
|
+ /** Constant for fs.open(). Flag indicating to open a file for read-only access. */
|
|
|
+ const O_RDONLY: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating to open a file for write-only access. */
|
|
|
+ const O_WRONLY: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating to open a file for read-write access. */
|
|
|
+ const O_RDWR: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating to create the file if it does not already exist. */
|
|
|
+ const O_CREAT: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating that opening a file should fail if the O_CREAT flag is set and the file already exists. */
|
|
|
+ const O_EXCL: number;
|
|
|
+ /**
|
|
|
+ * Constant for fs.open(). Flag indicating that if path identifies a terminal device,
|
|
|
+ * opening the path shall not cause that terminal to become the controlling terminal for the process
|
|
|
+ * (if the process does not already have one).
|
|
|
+ */
|
|
|
+ const O_NOCTTY: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating that if the file exists and is a regular file, and the file is opened successfully for write access, its length shall be truncated to zero. */
|
|
|
+ const O_TRUNC: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating that data will be appended to the end of the file. */
|
|
|
+ const O_APPEND: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating that the open should fail if the path is not a directory. */
|
|
|
+ const O_DIRECTORY: number;
|
|
|
+ /**
|
|
|
+ * constant for fs.open().
|
|
|
+ * Flag indicating reading accesses to the file system will no longer result in
|
|
|
+ * an update to the atime information associated with the file.
|
|
|
+ * This flag is available on Linux operating systems only.
|
|
|
+ */
|
|
|
+ const O_NOATIME: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating that the open should fail if the path is a symbolic link. */
|
|
|
+ const O_NOFOLLOW: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating that the file is opened for synchronous I/O. */
|
|
|
+ const O_SYNC: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating that the file is opened for synchronous I/O with write operations waiting for data integrity. */
|
|
|
+ const O_DSYNC: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating to open the symbolic link itself rather than the resource it is pointing to. */
|
|
|
+ const O_SYMLINK: number;
|
|
|
+ /** Constant for fs.open(). When set, an attempt will be made to minimize caching effects of file I/O. */
|
|
|
+ const O_DIRECT: number;
|
|
|
+ /** Constant for fs.open(). Flag indicating to open the file in nonblocking mode when possible. */
|
|
|
+ const O_NONBLOCK: number;
|
|
|
+ // File Type Constants
|
|
|
+ /** Constant for fs.Stats mode property for determining a file's type. Bit mask used to extract the file type code. */
|
|
|
+ const S_IFMT: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining a file's type. File type constant for a regular file. */
|
|
|
+ const S_IFREG: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining a file's type. File type constant for a directory. */
|
|
|
+ const S_IFDIR: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining a file's type. File type constant for a character-oriented device file. */
|
|
|
+ const S_IFCHR: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining a file's type. File type constant for a block-oriented device file. */
|
|
|
+ const S_IFBLK: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining a file's type. File type constant for a FIFO/pipe. */
|
|
|
+ const S_IFIFO: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining a file's type. File type constant for a symbolic link. */
|
|
|
+ const S_IFLNK: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining a file's type. File type constant for a socket. */
|
|
|
+ const S_IFSOCK: number;
|
|
|
+ // File Mode Constants
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by owner. */
|
|
|
+ const S_IRWXU: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by owner. */
|
|
|
+ const S_IRUSR: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by owner. */
|
|
|
+ const S_IWUSR: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by owner. */
|
|
|
+ const S_IXUSR: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by group. */
|
|
|
+ const S_IRWXG: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by group. */
|
|
|
+ const S_IRGRP: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by group. */
|
|
|
+ const S_IWGRP: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by group. */
|
|
|
+ const S_IXGRP: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by others. */
|
|
|
+ const S_IRWXO: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by others. */
|
|
|
+ const S_IROTH: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by others. */
|
|
|
+ const S_IWOTH: number;
|
|
|
+ /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by others. */
|
|
|
+ const S_IXOTH: number;
|
|
|
+ /**
|
|
|
+ * When set, a memory file mapping is used to access the file. This flag
|
|
|
+ * is available on Windows operating systems only. On other operating systems,
|
|
|
+ * this flag is ignored.
|
|
|
+ */
|
|
|
+ const UV_FS_O_FILEMAP: number;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Tests a user's permissions for the file or directory specified by `path`.
|
|
|
+ * The `mode` argument is an optional integer that specifies the accessibility
|
|
|
+ * checks to be performed. `mode` should be either the value `fs.constants.F_OK` or a mask consisting of the bitwise OR of any of `fs.constants.R_OK`, `fs.constants.W_OK`, and `fs.constants.X_OK`
|
|
|
+ * (e.g.`fs.constants.W_OK | fs.constants.R_OK`). Check `File access constants` for
|
|
|
+ * possible values of `mode`.
|
|
|
+ *
|
|
|
+ * The final argument, `callback`, is a callback function that is invoked with
|
|
|
+ * a possible error argument. If any of the accessibility checks fail, the error
|
|
|
+ * argument will be an `Error` object. The following examples check if `package.json` exists, and if it is readable or writable.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { access, constants } from 'node:fs';
|
|
|
+ *
|
|
|
+ * const file = 'package.json';
|
|
|
+ *
|
|
|
+ * // Check if the file exists in the current directory.
|
|
|
+ * access(file, constants.F_OK, (err) => {
|
|
|
+ * console.log(`${file} ${err ? 'does not exist' : 'exists'}`);
|
|
|
+ * });
|
|
|
+ *
|
|
|
+ * // Check if the file is readable.
|
|
|
+ * access(file, constants.R_OK, (err) => {
|
|
|
+ * console.log(`${file} ${err ? 'is not readable' : 'is readable'}`);
|
|
|
+ * });
|
|
|
+ *
|
|
|
+ * // Check if the file is writable.
|
|
|
+ * access(file, constants.W_OK, (err) => {
|
|
|
+ * console.log(`${file} ${err ? 'is not writable' : 'is writable'}`);
|
|
|
+ * });
|
|
|
+ *
|
|
|
+ * // Check if the file is readable and writable.
|
|
|
+ * access(file, constants.R_OK | constants.W_OK, (err) => {
|
|
|
+ * console.log(`${file} ${err ? 'is not' : 'is'} readable and writable`);
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * Do not use `fs.access()` to check for the accessibility of a file before calling `fs.open()`, `fs.readFile()`, or `fs.writeFile()`. Doing
|
|
|
+ * so introduces a race condition, since other processes may change the file's
|
|
|
+ * state between the two calls. Instead, user code should open/read/write the
|
|
|
+ * file directly and handle the error raised if the file is not accessible.
|
|
|
+ *
|
|
|
+ * **write (NOT RECOMMENDED)**
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { access, open, close } from 'node:fs';
|
|
|
+ *
|
|
|
+ * access('myfile', (err) => {
|
|
|
+ * if (!err) {
|
|
|
+ * console.error('myfile already exists');
|
|
|
+ * return;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * open('myfile', 'wx', (err, fd) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * writeMyData(fd);
|
|
|
+ * } finally {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * **write (RECOMMENDED)**
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { open, close } from 'node:fs';
|
|
|
+ *
|
|
|
+ * open('myfile', 'wx', (err, fd) => {
|
|
|
+ * if (err) {
|
|
|
+ * if (err.code === 'EEXIST') {
|
|
|
+ * console.error('myfile already exists');
|
|
|
+ * return;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * throw err;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * writeMyData(fd);
|
|
|
+ * } finally {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * **read (NOT RECOMMENDED)**
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { access, open, close } from 'node:fs';
|
|
|
+ * access('myfile', (err) => {
|
|
|
+ * if (err) {
|
|
|
+ * if (err.code === 'ENOENT') {
|
|
|
+ * console.error('myfile does not exist');
|
|
|
+ * return;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * throw err;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * open('myfile', 'r', (err, fd) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * readMyData(fd);
|
|
|
+ * } finally {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * **read (RECOMMENDED)**
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { open, close } from 'node:fs';
|
|
|
+ *
|
|
|
+ * open('myfile', 'r', (err, fd) => {
|
|
|
+ * if (err) {
|
|
|
+ * if (err.code === 'ENOENT') {
|
|
|
+ * console.error('myfile does not exist');
|
|
|
+ * return;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * throw err;
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * readMyData(fd);
|
|
|
+ * } finally {
|
|
|
+ * close(fd, (err) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * });
|
|
|
+ * }
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * The "not recommended" examples above check for accessibility and then use the
|
|
|
+ * file; the "recommended" examples are better because they use the file directly
|
|
|
+ * and handle the error, if any.
|
|
|
+ *
|
|
|
+ * In general, check for the accessibility of a file only if the file will not be
|
|
|
+ * used directly, for example when its accessibility is a signal from another
|
|
|
+ * process.
|
|
|
+ *
|
|
|
+ * On Windows, access-control policies (ACLs) on a directory may limit access to
|
|
|
+ * a file or directory. The `fs.access()` function, however, does not check the
|
|
|
+ * ACL and therefore may report that a path is accessible even if the ACL restricts
|
|
|
+ * the user from reading or writing to it.
|
|
|
+ * @since v0.11.15
|
|
|
+ * @param [mode=fs.constants.F_OK]
|
|
|
+ */
|
|
|
+ function access(path: PathLike, mode: number | undefined, callback: NoParamCallback): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously tests a user's permissions for the file specified by path.
|
|
|
+ * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ */
|
|
|
+ function access(path: PathLike, callback: NoParamCallback): void;
|
|
|
+ namespace access {
|
|
|
+ /**
|
|
|
+ * Asynchronously tests a user's permissions for the file specified by path.
|
|
|
+ * @param path A path to a file or directory. If a URL is provided, it must use the `file:` protocol.
|
|
|
+ * URL support is _experimental_.
|
|
|
+ */
|
|
|
+ function __promisify__(path: PathLike, mode?: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronously tests a user's permissions for the file or directory specified
|
|
|
+ * by `path`. The `mode` argument is an optional integer that specifies the
|
|
|
+ * accessibility checks to be performed. `mode` should be either the value `fs.constants.F_OK` or a mask consisting of the bitwise OR of any of `fs.constants.R_OK`, `fs.constants.W_OK`, and
|
|
|
+ * `fs.constants.X_OK` (e.g.`fs.constants.W_OK | fs.constants.R_OK`). Check `File access constants` for
|
|
|
+ * possible values of `mode`.
|
|
|
+ *
|
|
|
+ * If any of the accessibility checks fail, an `Error` will be thrown. Otherwise,
|
|
|
+ * the method will return `undefined`.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { accessSync, constants } from 'node:fs';
|
|
|
+ *
|
|
|
+ * try {
|
|
|
+ * accessSync('etc/passwd', constants.R_OK | constants.W_OK);
|
|
|
+ * console.log('can read/write');
|
|
|
+ * } catch (err) {
|
|
|
+ * console.error('no access!');
|
|
|
+ * }
|
|
|
+ * ```
|
|
|
+ * @since v0.11.15
|
|
|
+ * @param [mode=fs.constants.F_OK]
|
|
|
+ */
|
|
|
+ function accessSync(path: PathLike, mode?: number): void;
|
|
|
+ interface StreamOptions {
|
|
|
+ flags?: string | undefined;
|
|
|
+ encoding?: BufferEncoding | undefined;
|
|
|
+ fd?: number | FileHandle | undefined;
|
|
|
+ mode?: number | undefined;
|
|
|
+ autoClose?: boolean | undefined;
|
|
|
+ emitClose?: boolean | undefined;
|
|
|
+ start?: number | undefined;
|
|
|
+ signal?: AbortSignal | null | undefined;
|
|
|
+ highWaterMark?: number | undefined;
|
|
|
+ }
|
|
|
+ interface FSImplementation {
|
|
|
+ open?: (...args: any[]) => any;
|
|
|
+ close?: (...args: any[]) => any;
|
|
|
+ }
|
|
|
+ interface CreateReadStreamFSImplementation extends FSImplementation {
|
|
|
+ read: (...args: any[]) => any;
|
|
|
+ }
|
|
|
+ interface CreateWriteStreamFSImplementation extends FSImplementation {
|
|
|
+ write: (...args: any[]) => any;
|
|
|
+ writev?: (...args: any[]) => any;
|
|
|
+ }
|
|
|
+ interface ReadStreamOptions extends StreamOptions {
|
|
|
+ fs?: CreateReadStreamFSImplementation | null | undefined;
|
|
|
+ end?: number | undefined;
|
|
|
+ }
|
|
|
+ interface WriteStreamOptions extends StreamOptions {
|
|
|
+ fs?: CreateWriteStreamFSImplementation | null | undefined;
|
|
|
+ flush?: boolean | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * `options` can include `start` and `end` values to read a range of bytes from
|
|
|
+ * the file instead of the entire file. Both `start` and `end` are inclusive and
|
|
|
+ * start counting at 0, allowed values are in the
|
|
|
+ * \[0, [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER)\] range. If `fd` is specified and `start` is
|
|
|
+ * omitted or `undefined`, `fs.createReadStream()` reads sequentially from the
|
|
|
+ * current file position. The `encoding` can be any one of those accepted by `Buffer`.
|
|
|
+ *
|
|
|
+ * If `fd` is specified, `ReadStream` will ignore the `path` argument and will use
|
|
|
+ * the specified file descriptor. This means that no `'open'` event will be
|
|
|
+ * emitted. `fd` should be blocking; non-blocking `fd`s should be passed to `net.Socket`.
|
|
|
+ *
|
|
|
+ * If `fd` points to a character device that only supports blocking reads
|
|
|
+ * (such as keyboard or sound card), read operations do not finish until data is
|
|
|
+ * available. This can prevent the process from exiting and the stream from
|
|
|
+ * closing naturally.
|
|
|
+ *
|
|
|
+ * By default, the stream will emit a `'close'` event after it has been
|
|
|
+ * destroyed. Set the `emitClose` option to `false` to change this behavior.
|
|
|
+ *
|
|
|
+ * By providing the `fs` option, it is possible to override the corresponding `fs` implementations for `open`, `read`, and `close`. When providing the `fs` option,
|
|
|
+ * an override for `read` is required. If no `fd` is provided, an override for `open` is also required. If `autoClose` is `true`, an override for `close` is
|
|
|
+ * also required.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { createReadStream } from 'node:fs';
|
|
|
+ *
|
|
|
+ * // Create a stream from some character device.
|
|
|
+ * const stream = createReadStream('/dev/input/event0');
|
|
|
+ * setTimeout(() => {
|
|
|
+ * stream.close(); // This may not close the stream.
|
|
|
+ * // Artificially marking end-of-stream, as if the underlying resource had
|
|
|
+ * // indicated end-of-file by itself, allows the stream to close.
|
|
|
+ * // This does not cancel pending read operations, and if there is such an
|
|
|
+ * // operation, the process may still not be able to exit successfully
|
|
|
+ * // until it finishes.
|
|
|
+ * stream.push(null);
|
|
|
+ * stream.read(0);
|
|
|
+ * }, 100);
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * If `autoClose` is false, then the file descriptor won't be closed, even if
|
|
|
+ * there's an error. It is the application's responsibility to close it and make
|
|
|
+ * sure there's no file descriptor leak. If `autoClose` is set to true (default
|
|
|
+ * behavior), on `'error'` or `'end'` the file descriptor will be closed
|
|
|
+ * automatically.
|
|
|
+ *
|
|
|
+ * `mode` sets the file mode (permission and sticky bits), but only if the
|
|
|
+ * file was created.
|
|
|
+ *
|
|
|
+ * An example to read the last 10 bytes of a file which is 100 bytes long:
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { createReadStream } from 'node:fs';
|
|
|
+ *
|
|
|
+ * createReadStream('sample.txt', { start: 90, end: 99 });
|
|
|
+ * ```
|
|
|
+ *
|
|
|
+ * If `options` is a string, then it specifies the encoding.
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function createReadStream(path: PathLike, options?: BufferEncoding | ReadStreamOptions): ReadStream;
|
|
|
+ /**
|
|
|
+ * `options` may also include a `start` option to allow writing data at some
|
|
|
+ * position past the beginning of the file, allowed values are in the
|
|
|
+ * \[0, [`Number.MAX_SAFE_INTEGER`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/MAX_SAFE_INTEGER)\] range. Modifying a file rather than
|
|
|
+ * replacing it may require the `flags` option to be set to `r+` rather than the
|
|
|
+ * default `w`. The `encoding` can be any one of those accepted by `Buffer`.
|
|
|
+ *
|
|
|
+ * If `autoClose` is set to true (default behavior) on `'error'` or `'finish'` the file descriptor will be closed automatically. If `autoClose` is false,
|
|
|
+ * then the file descriptor won't be closed, even if there's an error.
|
|
|
+ * It is the application's responsibility to close it and make sure there's no
|
|
|
+ * file descriptor leak.
|
|
|
+ *
|
|
|
+ * By default, the stream will emit a `'close'` event after it has been
|
|
|
+ * destroyed. Set the `emitClose` option to `false` to change this behavior.
|
|
|
+ *
|
|
|
+ * By providing the `fs` option it is possible to override the corresponding `fs` implementations for `open`, `write`, `writev`, and `close`. Overriding `write()` without `writev()` can reduce
|
|
|
+ * performance as some optimizations (`_writev()`)
|
|
|
+ * will be disabled. When providing the `fs` option, overrides for at least one of `write` and `writev` are required. If no `fd` option is supplied, an override
|
|
|
+ * for `open` is also required. If `autoClose` is `true`, an override for `close` is also required.
|
|
|
+ *
|
|
|
+ * Like `fs.ReadStream`, if `fd` is specified, `fs.WriteStream` will ignore the `path` argument and will use the specified file descriptor. This means that no `'open'` event will be
|
|
|
+ * emitted. `fd` should be blocking; non-blocking `fd`s
|
|
|
+ * should be passed to `net.Socket`.
|
|
|
+ *
|
|
|
+ * If `options` is a string, then it specifies the encoding.
|
|
|
+ * @since v0.1.31
|
|
|
+ */
|
|
|
+ function createWriteStream(path: PathLike, options?: BufferEncoding | WriteStreamOptions): WriteStream;
|
|
|
+ /**
|
|
|
+ * Forces all currently queued I/O operations associated with the file to the
|
|
|
+ * operating system's synchronized I/O completion state. Refer to the POSIX [`fdatasync(2)`](http://man7.org/linux/man-pages/man2/fdatasync.2.html) documentation for details. No arguments other
|
|
|
+ * than a possible
|
|
|
+ * exception are given to the completion callback.
|
|
|
+ * @since v0.1.96
|
|
|
+ */
|
|
|
+ function fdatasync(fd: number, callback: NoParamCallback): void;
|
|
|
+ namespace fdatasync {
|
|
|
+ /**
|
|
|
+ * Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device.
|
|
|
+ * @param fd A file descriptor.
|
|
|
+ */
|
|
|
+ function __promisify__(fd: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Forces all currently queued I/O operations associated with the file to the
|
|
|
+ * operating system's synchronized I/O completion state. Refer to the POSIX [`fdatasync(2)`](http://man7.org/linux/man-pages/man2/fdatasync.2.html) documentation for details. Returns `undefined`.
|
|
|
+ * @since v0.1.96
|
|
|
+ */
|
|
|
+ function fdatasyncSync(fd: number): void;
|
|
|
+ /**
|
|
|
+ * Asynchronously copies `src` to `dest`. By default, `dest` is overwritten if it
|
|
|
+ * already exists. No arguments other than a possible exception are given to the
|
|
|
+ * callback function. Node.js makes no guarantees about the atomicity of the copy
|
|
|
+ * operation. If an error occurs after the destination file has been opened for
|
|
|
+ * writing, Node.js will attempt to remove the destination.
|
|
|
+ *
|
|
|
+ * `mode` is an optional integer that specifies the behavior
|
|
|
+ * of the copy operation. It is possible to create a mask consisting of the bitwise
|
|
|
+ * OR of two or more values (e.g.`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`).
|
|
|
+ *
|
|
|
+ * * `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already
|
|
|
+ * exists.
|
|
|
+ * * `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a
|
|
|
+ * copy-on-write reflink. If the platform does not support copy-on-write, then a
|
|
|
+ * fallback copy mechanism is used.
|
|
|
+ * * `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to
|
|
|
+ * create a copy-on-write reflink. If the platform does not support
|
|
|
+ * copy-on-write, then the operation will fail.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { copyFile, constants } from 'node:fs';
|
|
|
+ *
|
|
|
+ * function callback(err) {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log('source.txt was copied to destination.txt');
|
|
|
+ * }
|
|
|
+ *
|
|
|
+ * // destination.txt will be created or overwritten by default.
|
|
|
+ * copyFile('source.txt', 'destination.txt', callback);
|
|
|
+ *
|
|
|
+ * // By using COPYFILE_EXCL, the operation will fail if destination.txt exists.
|
|
|
+ * copyFile('source.txt', 'destination.txt', constants.COPYFILE_EXCL, callback);
|
|
|
+ * ```
|
|
|
+ * @since v8.5.0
|
|
|
+ * @param src source filename to copy
|
|
|
+ * @param dest destination filename of the copy operation
|
|
|
+ * @param [mode=0] modifiers for copy operation.
|
|
|
+ */
|
|
|
+ function copyFile(src: PathLike, dest: PathLike, callback: NoParamCallback): void;
|
|
|
+ function copyFile(src: PathLike, dest: PathLike, mode: number, callback: NoParamCallback): void;
|
|
|
+ namespace copyFile {
|
|
|
+ function __promisify__(src: PathLike, dst: PathLike, mode?: number): Promise<void>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronously copies `src` to `dest`. By default, `dest` is overwritten if it
|
|
|
+ * already exists. Returns `undefined`. Node.js makes no guarantees about the
|
|
|
+ * atomicity of the copy operation. If an error occurs after the destination file
|
|
|
+ * has been opened for writing, Node.js will attempt to remove the destination.
|
|
|
+ *
|
|
|
+ * `mode` is an optional integer that specifies the behavior
|
|
|
+ * of the copy operation. It is possible to create a mask consisting of the bitwise
|
|
|
+ * OR of two or more values (e.g.`fs.constants.COPYFILE_EXCL | fs.constants.COPYFILE_FICLONE`).
|
|
|
+ *
|
|
|
+ * * `fs.constants.COPYFILE_EXCL`: The copy operation will fail if `dest` already
|
|
|
+ * exists.
|
|
|
+ * * `fs.constants.COPYFILE_FICLONE`: The copy operation will attempt to create a
|
|
|
+ * copy-on-write reflink. If the platform does not support copy-on-write, then a
|
|
|
+ * fallback copy mechanism is used.
|
|
|
+ * * `fs.constants.COPYFILE_FICLONE_FORCE`: The copy operation will attempt to
|
|
|
+ * create a copy-on-write reflink. If the platform does not support
|
|
|
+ * copy-on-write, then the operation will fail.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { copyFileSync, constants } from 'node:fs';
|
|
|
+ *
|
|
|
+ * // destination.txt will be created or overwritten by default.
|
|
|
+ * copyFileSync('source.txt', 'destination.txt');
|
|
|
+ * console.log('source.txt was copied to destination.txt');
|
|
|
+ *
|
|
|
+ * // By using COPYFILE_EXCL, the operation will fail if destination.txt exists.
|
|
|
+ * copyFileSync('source.txt', 'destination.txt', constants.COPYFILE_EXCL);
|
|
|
+ * ```
|
|
|
+ * @since v8.5.0
|
|
|
+ * @param src source filename to copy
|
|
|
+ * @param dest destination filename of the copy operation
|
|
|
+ * @param [mode=0] modifiers for copy operation.
|
|
|
+ */
|
|
|
+ function copyFileSync(src: PathLike, dest: PathLike, mode?: number): void;
|
|
|
+ /**
|
|
|
+ * Write an array of `ArrayBufferView`s to the file specified by `fd` using `writev()`.
|
|
|
+ *
|
|
|
+ * `position` is the offset from the beginning of the file where this data
|
|
|
+ * should be written. If `typeof position !== 'number'`, the data will be written
|
|
|
+ * at the current position.
|
|
|
+ *
|
|
|
+ * The callback will be given three arguments: `err`, `bytesWritten`, and `buffers`. `bytesWritten` is how many bytes were written from `buffers`.
|
|
|
+ *
|
|
|
+ * If this method is `util.promisify()` ed, it returns a promise for an `Object` with `bytesWritten` and `buffers` properties.
|
|
|
+ *
|
|
|
+ * It is unsafe to use `fs.writev()` multiple times on the same file without
|
|
|
+ * waiting for the callback. For this scenario, use {@link createWriteStream}.
|
|
|
+ *
|
|
|
+ * On Linux, positional writes don't work when the file is opened in append mode.
|
|
|
+ * The kernel ignores the position argument and always appends the data to
|
|
|
+ * the end of the file.
|
|
|
+ * @since v12.9.0
|
|
|
+ * @param [position='null']
|
|
|
+ */
|
|
|
+ function writev<TBuffers extends readonly NodeJS.ArrayBufferView[]>(
|
|
|
+ fd: number,
|
|
|
+ buffers: TBuffers,
|
|
|
+ cb: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffers: TBuffers) => void,
|
|
|
+ ): void;
|
|
|
+ function writev<TBuffers extends readonly NodeJS.ArrayBufferView[]>(
|
|
|
+ fd: number,
|
|
|
+ buffers: TBuffers,
|
|
|
+ position: number | null,
|
|
|
+ cb: (err: NodeJS.ErrnoException | null, bytesWritten: number, buffers: TBuffers) => void,
|
|
|
+ ): void;
|
|
|
+ // Providing a default type parameter doesn't provide true BC for userland consumers, but at least suppresses TS2314
|
|
|
+ // TODO: remove default in future major version
|
|
|
+ interface WriteVResult<T extends readonly NodeJS.ArrayBufferView[] = NodeJS.ArrayBufferView[]> {
|
|
|
+ bytesWritten: number;
|
|
|
+ buffers: T;
|
|
|
+ }
|
|
|
+ namespace writev {
|
|
|
+ function __promisify__<TBuffers extends readonly NodeJS.ArrayBufferView[]>(
|
|
|
+ fd: number,
|
|
|
+ buffers: TBuffers,
|
|
|
+ position?: number,
|
|
|
+ ): Promise<WriteVResult<TBuffers>>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link writev}.
|
|
|
+ * @since v12.9.0
|
|
|
+ * @param [position='null']
|
|
|
+ * @return The number of bytes written.
|
|
|
+ */
|
|
|
+ function writevSync(fd: number, buffers: readonly NodeJS.ArrayBufferView[], position?: number): number;
|
|
|
+ /**
|
|
|
+ * Read from a file specified by `fd` and write to an array of `ArrayBufferView`s
|
|
|
+ * using `readv()`.
|
|
|
+ *
|
|
|
+ * `position` is the offset from the beginning of the file from where data
|
|
|
+ * should be read. If `typeof position !== 'number'`, the data will be read
|
|
|
+ * from the current position.
|
|
|
+ *
|
|
|
+ * The callback will be given three arguments: `err`, `bytesRead`, and `buffers`. `bytesRead` is how many bytes were read from the file.
|
|
|
+ *
|
|
|
+ * If this method is invoked as its `util.promisify()` ed version, it returns
|
|
|
+ * a promise for an `Object` with `bytesRead` and `buffers` properties.
|
|
|
+ * @since v13.13.0, v12.17.0
|
|
|
+ * @param [position='null']
|
|
|
+ */
|
|
|
+ function readv<TBuffers extends readonly NodeJS.ArrayBufferView[]>(
|
|
|
+ fd: number,
|
|
|
+ buffers: TBuffers,
|
|
|
+ cb: (err: NodeJS.ErrnoException | null, bytesRead: number, buffers: TBuffers) => void,
|
|
|
+ ): void;
|
|
|
+ function readv<TBuffers extends readonly NodeJS.ArrayBufferView[]>(
|
|
|
+ fd: number,
|
|
|
+ buffers: TBuffers,
|
|
|
+ position: number | null,
|
|
|
+ cb: (err: NodeJS.ErrnoException | null, bytesRead: number, buffers: TBuffers) => void,
|
|
|
+ ): void;
|
|
|
+ // Providing a default type parameter doesn't provide true BC for userland consumers, but at least suppresses TS2314
|
|
|
+ // TODO: remove default in future major version
|
|
|
+ interface ReadVResult<T extends readonly NodeJS.ArrayBufferView[] = NodeJS.ArrayBufferView[]> {
|
|
|
+ bytesRead: number;
|
|
|
+ buffers: T;
|
|
|
+ }
|
|
|
+ namespace readv {
|
|
|
+ function __promisify__<TBuffers extends readonly NodeJS.ArrayBufferView[]>(
|
|
|
+ fd: number,
|
|
|
+ buffers: TBuffers,
|
|
|
+ position?: number,
|
|
|
+ ): Promise<ReadVResult<TBuffers>>;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * For detailed information, see the documentation of the asynchronous version of
|
|
|
+ * this API: {@link readv}.
|
|
|
+ * @since v13.13.0, v12.17.0
|
|
|
+ * @param [position='null']
|
|
|
+ * @return The number of bytes read.
|
|
|
+ */
|
|
|
+ function readvSync(fd: number, buffers: readonly NodeJS.ArrayBufferView[], position?: number): number;
|
|
|
+
|
|
|
+ interface OpenAsBlobOptions {
|
|
|
+ /**
|
|
|
+ * An optional mime type for the blob.
|
|
|
+ *
|
|
|
+ * @default 'undefined'
|
|
|
+ */
|
|
|
+ type?: string | undefined;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Returns a `Blob` whose data is backed by the given file.
|
|
|
+ *
|
|
|
+ * The file must not be modified after the `Blob` is created. Any modifications
|
|
|
+ * will cause reading the `Blob` data to fail with a `DOMException` error.
|
|
|
+ * Synchronous stat operations on the file when the `Blob` is created, and before
|
|
|
+ * each read in order to detect whether the file data has been modified on disk.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { openAsBlob } from 'node:fs';
|
|
|
+ *
|
|
|
+ * const blob = await openAsBlob('the.file.txt');
|
|
|
+ * const ab = await blob.arrayBuffer();
|
|
|
+ * blob.stream();
|
|
|
+ * ```
|
|
|
+ * @since v19.8.0
|
|
|
+ */
|
|
|
+ function openAsBlob(path: PathLike, options?: OpenAsBlobOptions): Promise<Blob>;
|
|
|
+
|
|
|
+ interface OpenDirOptions {
|
|
|
+ /**
|
|
|
+ * @default 'utf8'
|
|
|
+ */
|
|
|
+ encoding?: BufferEncoding | undefined;
|
|
|
+ /**
|
|
|
+ * Number of directory entries that are buffered
|
|
|
+ * internally when reading from the directory. Higher values lead to better
|
|
|
+ * performance but higher memory usage.
|
|
|
+ * @default 32
|
|
|
+ */
|
|
|
+ bufferSize?: number | undefined;
|
|
|
+ /**
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Synchronously open a directory. See [`opendir(3)`](http://man7.org/linux/man-pages/man3/opendir.3.html).
|
|
|
+ *
|
|
|
+ * Creates an `fs.Dir`, which contains all further functions for reading from
|
|
|
+ * and cleaning up the directory.
|
|
|
+ *
|
|
|
+ * The `encoding` option sets the encoding for the `path` while opening the
|
|
|
+ * directory and subsequent read operations.
|
|
|
+ * @since v12.12.0
|
|
|
+ */
|
|
|
+ function opendirSync(path: PathLike, options?: OpenDirOptions): Dir;
|
|
|
+ /**
|
|
|
+ * Asynchronously open a directory. See the POSIX [`opendir(3)`](http://man7.org/linux/man-pages/man3/opendir.3.html) documentation for
|
|
|
+ * more details.
|
|
|
+ *
|
|
|
+ * Creates an `fs.Dir`, which contains all further functions for reading from
|
|
|
+ * and cleaning up the directory.
|
|
|
+ *
|
|
|
+ * The `encoding` option sets the encoding for the `path` while opening the
|
|
|
+ * directory and subsequent read operations.
|
|
|
+ * @since v12.12.0
|
|
|
+ */
|
|
|
+ function opendir(path: PathLike, cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void): void;
|
|
|
+ function opendir(
|
|
|
+ path: PathLike,
|
|
|
+ options: OpenDirOptions,
|
|
|
+ cb: (err: NodeJS.ErrnoException | null, dir: Dir) => void,
|
|
|
+ ): void;
|
|
|
+ namespace opendir {
|
|
|
+ function __promisify__(path: PathLike, options?: OpenDirOptions): Promise<Dir>;
|
|
|
+ }
|
|
|
+ interface BigIntStats extends StatsBase<bigint> {
|
|
|
+ atimeNs: bigint;
|
|
|
+ mtimeNs: bigint;
|
|
|
+ ctimeNs: bigint;
|
|
|
+ birthtimeNs: bigint;
|
|
|
+ }
|
|
|
+ interface BigIntOptions {
|
|
|
+ bigint: true;
|
|
|
+ }
|
|
|
+ interface StatOptions {
|
|
|
+ bigint?: boolean | undefined;
|
|
|
+ }
|
|
|
+ interface StatSyncOptions extends StatOptions {
|
|
|
+ throwIfNoEntry?: boolean | undefined;
|
|
|
+ }
|
|
|
+ interface CopyOptionsBase {
|
|
|
+ /**
|
|
|
+ * Dereference symlinks
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ dereference?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * When `force` is `false`, and the destination
|
|
|
+ * exists, throw an error.
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ errorOnExist?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * Overwrite existing file or directory. _The copy
|
|
|
+ * operation will ignore errors if you set this to false and the destination
|
|
|
+ * exists. Use the `errorOnExist` option to change this behavior.
|
|
|
+ * @default true
|
|
|
+ */
|
|
|
+ force?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * Modifiers for copy operation. See `mode` flag of {@link copyFileSync()}
|
|
|
+ */
|
|
|
+ mode?: number | undefined;
|
|
|
+ /**
|
|
|
+ * When `true` timestamps from `src` will
|
|
|
+ * be preserved.
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ preserveTimestamps?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * Copy directories recursively.
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ recursive?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * When true, path resolution for symlinks will be skipped
|
|
|
+ * @default false
|
|
|
+ */
|
|
|
+ verbatimSymlinks?: boolean | undefined;
|
|
|
+ }
|
|
|
+ interface CopyOptions extends CopyOptionsBase {
|
|
|
+ /**
|
|
|
+ * Function to filter copied files/directories. Return
|
|
|
+ * `true` to copy the item, `false` to ignore it.
|
|
|
+ */
|
|
|
+ filter?: ((source: string, destination: string) => boolean | Promise<boolean>) | undefined;
|
|
|
+ }
|
|
|
+ interface CopySyncOptions extends CopyOptionsBase {
|
|
|
+ /**
|
|
|
+ * Function to filter copied files/directories. Return
|
|
|
+ * `true` to copy the item, `false` to ignore it.
|
|
|
+ */
|
|
|
+ filter?: ((source: string, destination: string) => boolean) | undefined;
|
|
|
+ }
|
|
|
+ /**
|
|
|
+ * Asynchronously copies the entire directory structure from `src` to `dest`,
|
|
|
+ * including subdirectories and files.
|
|
|
+ *
|
|
|
+ * When copying a directory to another directory, globs are not supported and
|
|
|
+ * behavior is similar to `cp dir1/ dir2/`.
|
|
|
+ * @since v16.7.0
|
|
|
+ * @experimental
|
|
|
+ * @param src source path to copy.
|
|
|
+ * @param dest destination path to copy to.
|
|
|
+ */
|
|
|
+ function cp(
|
|
|
+ source: string | URL,
|
|
|
+ destination: string | URL,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null) => void,
|
|
|
+ ): void;
|
|
|
+ function cp(
|
|
|
+ source: string | URL,
|
|
|
+ destination: string | URL,
|
|
|
+ opts: CopyOptions,
|
|
|
+ callback: (err: NodeJS.ErrnoException | null) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * Synchronously copies the entire directory structure from `src` to `dest`,
|
|
|
+ * including subdirectories and files.
|
|
|
+ *
|
|
|
+ * When copying a directory to another directory, globs are not supported and
|
|
|
+ * behavior is similar to `cp dir1/ dir2/`.
|
|
|
+ * @since v16.7.0
|
|
|
+ * @experimental
|
|
|
+ * @param src source path to copy.
|
|
|
+ * @param dest destination path to copy to.
|
|
|
+ */
|
|
|
+ function cpSync(source: string | URL, destination: string | URL, opts?: CopySyncOptions): void;
|
|
|
+
|
|
|
+ // TODO: collapse
|
|
|
+ interface _GlobOptions<T extends Dirent | string> {
|
|
|
+ /**
|
|
|
+ * Current working directory.
|
|
|
+ * @default process.cwd()
|
|
|
+ */
|
|
|
+ cwd?: string | URL | undefined;
|
|
|
+ /**
|
|
|
+ * `true` if the glob should return paths as `Dirent`s, `false` otherwise.
|
|
|
+ * @default false
|
|
|
+ * @since v22.2.0
|
|
|
+ */
|
|
|
+ withFileTypes?: boolean | undefined;
|
|
|
+ /**
|
|
|
+ * Function to filter out files/directories or a
|
|
|
+ * list of glob patterns to be excluded. If a function is provided, return
|
|
|
+ * `true` to exclude the item, `false` to include it.
|
|
|
+ * If a string array is provided, each string should be a glob pattern that
|
|
|
+ * specifies paths to exclude. Note: Negation patterns (e.g., '!foo.js') are
|
|
|
+ * not supported.
|
|
|
+ * @default undefined
|
|
|
+ */
|
|
|
+ exclude?: ((fileName: T) => boolean) | readonly string[] | undefined;
|
|
|
+ }
|
|
|
+ interface GlobOptions extends _GlobOptions<Dirent | string> {}
|
|
|
+ interface GlobOptionsWithFileTypes extends _GlobOptions<Dirent> {
|
|
|
+ withFileTypes: true;
|
|
|
+ }
|
|
|
+ interface GlobOptionsWithoutFileTypes extends _GlobOptions<string> {
|
|
|
+ withFileTypes?: false | undefined;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Retrieves the files matching the specified pattern.
|
|
|
+ *
|
|
|
+ * ```js
|
|
|
+ * import { glob } from 'node:fs';
|
|
|
+ *
|
|
|
+ * glob('*.js', (err, matches) => {
|
|
|
+ * if (err) throw err;
|
|
|
+ * console.log(matches);
|
|
|
+ * });
|
|
|
+ * ```
|
|
|
+ * @since v22.0.0
|
|
|
+ */
|
|
|
+ function glob(
|
|
|
+ pattern: string | readonly string[],
|
|
|
+ callback: (err: NodeJS.ErrnoException | null, matches: string[]) => void,
|
|
|
+ ): void;
|
|
|
+ function glob(
|
|
|
+ pattern: string | readonly string[],
|
|
|
+ options: GlobOptionsWithFileTypes,
|
|
|
+ callback: (
|
|
|
+ err: NodeJS.ErrnoException | null,
|
|
|
+ matches: Dirent[],
|
|
|
+ ) => void,
|
|
|
+ ): void;
|
|
|
+ function glob(
|
|
|
+ pattern: string | readonly string[],
|
|
|
+ options: GlobOptionsWithoutFileTypes,
|
|
|
+ callback: (
|
|
|
+ err: NodeJS.ErrnoException | null,
|
|
|
+ matches: string[],
|
|
|
+ ) => void,
|
|
|
+ ): void;
|
|
|
+ function glob(
|
|
|
+ pattern: string | readonly string[],
|
|
|
+ options: GlobOptions,
|
|
|
+ callback: (
|
|
|
+ err: NodeJS.ErrnoException | null,
|
|
|
+ matches: Dirent[] | string[],
|
|
|
+ ) => void,
|
|
|
+ ): void;
|
|
|
+ /**
|
|
|
+ * ```js
|
|
|
+ * import { globSync } from 'node:fs';
|
|
|
+ *
|
|
|
+ * console.log(globSync('*.js'));
|
|
|
+ * ```
|
|
|
+ * @since v22.0.0
|
|
|
+ * @returns paths of files that match the pattern.
|
|
|
+ */
|
|
|
+ function globSync(pattern: string | readonly string[]): string[];
|
|
|
+ function globSync(
|
|
|
+ pattern: string | readonly string[],
|
|
|
+ options: GlobOptionsWithFileTypes,
|
|
|
+ ): Dirent[];
|
|
|
+ function globSync(
|
|
|
+ pattern: string | readonly string[],
|
|
|
+ options: GlobOptionsWithoutFileTypes,
|
|
|
+ ): string[];
|
|
|
+ function globSync(
|
|
|
+ pattern: string | readonly string[],
|
|
|
+ options: GlobOptions,
|
|
|
+ ): Dirent[] | string[];
|
|
|
+}
|
|
|
+declare module "node:fs" {
|
|
|
+ export * as promises from "node:fs/promises";
|
|
|
+}
|
|
|
+declare module "fs" {
|
|
|
+ export * from "node:fs";
|
|
|
+}
|