@zenfs/core 1.0.10 → 1.0.11

package/dist/emulation/async.js

@@ -9,11 +9,7 @@ import { ReadStream, WriteStream } from './streams.js';
 import { FSWatcher, StatWatcher } from './watchers.js';
 const nop = () => { };
 /**
- * Asynchronous rename. No arguments other than a possible exception are given
- * to the completion callback.
- * @param oldPath
- * @param newPath
- * @param callback
+ * Asynchronous rename. No arguments other than a possible exception are given to the completion callback.
  */
 export function rename(oldPath, newPath, cb = nop) {
     promises
@@ -23,10 +19,8 @@ export function rename(oldPath, newPath, cb = nop) {
 }
 rename;
 /**
- * Test whether or not the given path exists by checking with the file system.
+ * Test whether or not `path` exists by checking with the file system.
  * Then call the callback argument with either true or false.
- * @param path
- * @param callback
  * @deprecated Use {@link stat} or {@link access} instead.
  */
 export function exists(path, cb = nop) {
@@ -61,11 +55,6 @@ export function truncate(path, cbLen = 0, cb = nop) {
         .catch(cb);
 }
 truncate;
-/**
- * Asynchronous `unlink`.
- * @param path
- * @param callback
- */
 export function unlink(path, cb = nop) {
     promises
         .unlink(path)
@@ -115,11 +104,6 @@ export function fstat(fd, options, cb = nop) {
         .catch(cb);
 }
 fstat;
-/**
- * Asynchronous close.
- * @param fd
- * @param callback
- */
 export function close(fd, cb = nop) {
     new promises.FileHandle(fd)
         .close()
@@ -139,11 +123,6 @@ export function ftruncate(fd, lenOrCB, cb = nop) {
         .catch(cb);
 }
 ftruncate;
-/**
- * Asynchronous fsync.
- * @param fd
- * @param callback
- */
 export function fsync(fd, cb = nop) {
     fd2file(fd)
         .sync()
@@ -151,11 +130,6 @@ export function fsync(fd, cb = nop) {
         .catch(cb);
 }
 fsync;
-/**
- * Asynchronous fdatasync.
- * @param fd
- * @param callback
- */
 export function fdatasync(fd, cb = nop) {
     fd2file(fd)
         .datasync()
@@ -211,15 +185,12 @@ export function write(fd, data, cbPosOff, cbLenEnc, cbPosEnc, cb = nop) {
 write;
 /**
  * Read data from the file specified by `fd`.
- * @param buffer The buffer that the data will be
- *   written to.
- * @param offset The offset within the buffer where writing will
- *   start.
+ * @param buffer The buffer that the data will be written to.
+ * @param offset The offset within the buffer where writing will start.
  * @param length An integer specifying the number of bytes to read.
- * @param position An integer specifying where to begin reading from
- *   in the file. If position is null, data will be read from the current file
- *   position.
- * @param callback The number is the number of bytes read
+ * @param position An integer specifying where to begin reading from in the file.
+ * If position is null, data will be read from the current file position.
+ * @param cb The number is the number of bytes read
  */
 export function read(fd, buffer, offset, length, position, cb = nop) {
     new promises.FileHandle(fd)
@@ -228,13 +199,6 @@ export function read(fd, buffer, offset, length, position, cb = nop) {
         .catch(cb);
 }
 read;
-/**
- * Asynchronous `fchown`.
- * @param fd
- * @param uid
- * @param gid
- * @param callback
- */
 export function fchown(fd, uid, gid, cb = nop) {
     new promises.FileHandle(fd)
         .chown(uid, gid)
@@ -242,12 +206,6 @@ export function fchown(fd, uid, gid, cb = nop) {
         .catch(cb);
 }
 fchown;
-/**
- * Asynchronous `fchmod`.
- * @param fd
- * @param mode
- * @param callback
- */
 export function fchmod(fd, mode, cb) {
     new promises.FileHandle(fd)
         .chmod(mode)
@@ -256,12 +214,7 @@ export function fchmod(fd, mode, cb) {
 }
 fchmod;
 /**
- * Change the file timestamps of a file referenced by the supplied file
- * descriptor.
- * @param fd
- * @param atime
- * @param mtime
- * @param callback
+ * Change the file timestamps of a file referenced by the supplied file descriptor.
  */
 export function futimes(fd, atime, mtime, cb = nop) {
     new promises.FileHandle(fd)
@@ -270,11 +223,6 @@ export function futimes(fd, atime, mtime, cb = nop) {
         .catch(cb);
 }
 futimes;
-/**
- * Asynchronous `rmdir`.
- * @param path
- * @param callback
- */
 export function rmdir(path, cb = nop) {
     promises
         .rmdir(path)
@@ -284,9 +232,7 @@ export function rmdir(path, cb = nop) {
 rmdir;
 /**
  * Asynchronous `mkdir`.
- * @param path
  * @param mode defaults to `0777`
- * @param callback
  */
 export function mkdir(path, mode, cb = nop) {
     promises
@@ -304,12 +250,6 @@ export function readdir(path, _options, cb = nop) {
         .catch(cb);
 }
 readdir;
-/**
- * Asynchronous `link`.
- * @param existing
- * @param newpath
- * @param callback
- */
 export function link(existing, newpath, cb = nop) {
     promises
         .link(existing, newpath)
@@ -334,13 +274,6 @@ export function readlink(path, options, callback = nop) {
         .catch(callback);
 }
 readlink;
-/**
- * Asynchronous `chown`.
- * @param path
- * @param uid
- * @param gid
- * @param callback
- */
 export function chown(path, uid, gid, cb = nop) {
     promises
         .chown(path, uid, gid)
@@ -348,13 +281,6 @@ export function chown(path, uid, gid, cb = nop) {
         .catch(cb);
 }
 chown;
-/**
- * Asynchronous `lchown`.
- * @param path
- * @param uid
- * @param gid
- * @param callback
- */
 export function lchown(path, uid, gid, cb = nop) {
     promises
         .lchown(path, uid, gid)
@@ -362,12 +288,6 @@ export function lchown(path, uid, gid, cb = nop) {
         .catch(cb);
 }
 lchown;
-/**
- * Asynchronous `chmod`.
- * @param path
- * @param mode
- * @param callback
- */
 export function chmod(path, mode, cb = nop) {
     promises
         .chmod(path, mode)
@@ -375,12 +295,6 @@ export function chmod(path, mode, cb = nop) {
         .catch(cb);
 }
 chmod;
-/**
- * Asynchronous `lchmod`.
- * @param path
- * @param mode
- * @param callback
- */
 export function lchmod(path, mode, cb = nop) {
     promises
         .lchmod(path, mode)
@@ -390,10 +304,6 @@ export function lchmod(path, mode, cb = nop) {
 lchmod;
 /**
  * Change file timestamps of the file referenced by the supplied path.
- * @param path
- * @param atime
- * @param mtime
- * @param callback
  */
 export function utimes(path, atime, mtime, cb = nop) {
     promises
@@ -404,10 +314,6 @@ export function utimes(path, atime, mtime, cb = nop) {
 utimes;
 /**
  * Change file timestamps of the file referenced by the supplied path.
- * @param path
- * @param atime
- * @param mtime
- * @param callback
  */
 export function lutimes(path, atime, mtime, cb = nop) {
     promises
@@ -434,11 +340,11 @@ export function access(path, cbMode, cb = nop) {
 }
 access;
 const statWatchers = new Map();
-export function watchFile(path, optsListener, listener) {
+export function watchFile(path, options, listener) {
     const normalizedPath = normalizePath(path.toString());
-    const options = typeof optsListener != 'function' ? optsListener : {};
-    if (typeof optsListener === 'function') {
-        listener = optsListener;
+    const opts = typeof options != 'function' ? options : {};
+    if (typeof options == 'function') {
+        listener = options;
     }
     if (!listener) {
         throw new ErrnoError(Errno.EINVAL, 'No listener specified', path.toString(), 'watchFile');
@@ -450,7 +356,7 @@ export function watchFile(path, optsListener, listener) {
         }
         return;
     }
-    const watcher = new StatWatcher(normalizedPath, options);
+    const watcher = new StatWatcher(normalizedPath, opts);
     watcher.on('change', (curr, prev) => {
         const entry = statWatchers.get(normalizedPath);
         if (!entry) {
@@ -505,8 +411,8 @@ watch;
  * @param options Options for the ReadStream and file opening (e.g., `encoding`, `highWaterMark`, `mode`).
  * @returns A ReadStream object for interacting with the file's contents.
  */
-export function createReadStream(path, _options) {
-    const options = typeof _options == 'object' ? _options : { encoding: _options };
+export function createReadStream(path, options) {
+    options = typeof options == 'object' ? options : { encoding: options };
     let handle;
     const stream = new ReadStream({
         highWaterMark: options.highWaterMark || 64 * 1024,
@@ -544,8 +450,8 @@ createReadStream;
  * @param options Options for the WriteStream and file opening (e.g., `encoding`, `highWaterMark`, `mode`).
  * @returns A WriteStream object for writing to the file.
  */
-export function createWriteStream(path, _options) {
-    const options = typeof _options == 'object' ? _options : { encoding: _options };
+export function createWriteStream(path, options) {
+    options = typeof options == 'object' ? options : { encoding: options };
     let handle;
     const stream = new WriteStream({
         highWaterMark: options?.highWaterMark,

package/dist/emulation/dir.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 import type { Dir as _Dir, Dirent as _Dirent } from 'fs';
 import type { Stats } from '../stats.js';
 import type { Callback } from '../utils.js';

package/dist/emulation/path.d.ts

@@ -1,8 +1,4 @@
-/// <reference types="node" resolution-mode="require"/>
 import type { ParsedPath } from 'node:path';
-/**
- * An absolute path
- */
 export type AbsolutePath = `/${string}`;
 export declare let cwd: string;
 export declare function cd(path: string): void;

package/dist/emulation/path.js

@@ -265,14 +265,12 @@ export function basename(path, suffix) {
                     // Try to match the explicit extension
                     if (path[i] === suffix[extIdx]) {
                         if (--extIdx === -1) {
-                            // We matched the extension, so mark this as the end of our path
-                            // component
+                            // We matched the extension, so mark this as the end of our path component
                             end = i;
                         }
                     }
                     else {
-                        // Extension does not match, so our result is the entire path
-                        // component
+                        // Extension does not match, so our result is the entire path component
                         extIdx = -1;
                         end = firstNonSlashEnd;
                     }
@@ -287,16 +285,14 @@ export function basename(path, suffix) {
     }
     for (let i = path.length - 1; i >= 0; --i) {
         if (path[i] === '/') {
-            // If we reached a path separator that was not part of a set of path
-            // separators at the end of the string, stop now
+            // If we reached a path separator that was not part of a set of path separators at the end of the string, stop now
             if (!matchedSlash) {
                 start = i + 1;
                 break;
             }
         }
         else if (end === -1) {
-            // We saw the first non-path separator, mark this as the end of our
-            // path component
+            // We saw the first non-path separator, mark this as the end of our path component
             matchedSlash = false;
             end = i + 1;
         }

package/dist/emulation/promises.d.ts

@@ -1,11 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
 import { Buffer } from 'buffer';
 import type * as fs from 'node:fs';
 import type * as promises from 'node:fs/promises';
@@ -50,9 +42,9 @@ export declare class FileHandle implements promises.FileHandle {
     sync(): Promise<void>;
     /**
      * Asynchronous ftruncate(2) - Truncate a file to a specified length.
-     * @param len If not specified, defaults to `0`.
+     * @param length If not specified, defaults to `0`.
      */
-    truncate(len?: number | null): Promise<void>;
+    truncate(length?: number | null): Promise<void>;
     /**
      * Asynchronously change file timestamps of the file.
      * @param atime The last access time. If a string is provided, it will be coerced to number.
@@ -64,10 +56,9 @@ export declare class FileHandle implements promises.FileHandle {
      * The `FileHandle` must have been opened for appending.
      * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string.
      * @param _options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag.
-     * 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.
+     * - `encoding` defaults to `'utf8'`.
+     * - `mode` defaults to `0o666`.
+     * - `flag` defaults to `'a'`.
      */
     appendFile(data: string | Uint8Array, _options?: (fs.ObjectEncodingOptions & FlagAndOpenMode) | BufferEncoding): Promise<void>;
     /**
@@ -92,10 +83,11 @@ export declare class FileHandle implements promises.FileHandle {
     /**
      * Returns a `ReadableStream` that may be used to read the files data.
      *
-     * An error will be thrown if this method is called more than once or is called after the `FileHandle` is closed
-     * or closing.
+     * An error will be thrown if this method is called more than once or is called after the `FileHandle` is closed or closing.
      *
-     * While the `ReadableStream` will read the file to completion, it will not close the `FileHandle` automatically. User code must still call the `fileHandle.close()` method.
+     * While the `ReadableStream` will read the file to completion,
+     * it will not close the `FileHandle` automatically.
+     * User code must still call the `fileHandle.close()` method.
      *
      * @since v17.0.0
      * @experimental
@@ -134,10 +126,9 @@ export declare class FileHandle implements promises.FileHandle {
      * It is unsafe to call `writeFile()` multiple times on the same file without waiting for the `Promise` to be resolved (or rejected).
      * @param data The data to write. If something other than a `Buffer` or `Uint8Array` is provided, the value is coerced to a string.
      * @param _options Either the encoding for the file, or an object optionally specifying the encoding, file mode, and flag.
-     * 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.
+     * - `encoding` defaults to `'utf8'`.
+     * - `mode` defaults to `0o666`.
+     * - `flag` defaults to `'w'`.
      */
     writeFile(data: string | Uint8Array, _options?: fs.WriteFileOptions): Promise<void>;
     /**
@@ -159,36 +150,21 @@ export declare class FileHandle implements promises.FileHandle {
      */
     readv(buffers: NodeJS.ArrayBufferView[], position?: number): Promise<fs.ReadVResult>;
     /**
-     * Creates a `ReadStream` for reading from the file.
-     *
+     * Creates a stream for reading from the file.
      * @param options Options for the readable stream
-     * @returns A `ReadStream` object.
      */
     createReadStream(options?: CreateReadStreamOptions): ReadStream;
     /**
-     * Creates a `WriteStream` for writing to the file.
-     *
+     * Creates a stream for writing to the file.
      * @param options Options for the writeable stream.
-     * @returns A `WriteStream` object
      */
     createWriteStream(options?: CreateWriteStreamOptions): WriteStream;
 }
-/**
- * Renames a file
- * @param oldPath
- * @param newPath
- */
 export declare function rename(oldPath: fs.PathLike, newPath: fs.PathLike): Promise<void>;
 /**
- * Test whether or not the given path exists by checking with the file system.
- * @param path
+ * Test whether or not `path` exists by checking with the file system.
  */
 export declare function exists(path: fs.PathLike): Promise<boolean>;
-/**
- * `stat`.
- * @param path
- * @returns Stats
- */
 export declare function stat(path: fs.PathLike, options: fs.BigIntOptions): Promise<BigIntStats>;
 export declare function stat(path: fs.PathLike, options?: {
     bigint?: false;
@@ -198,8 +174,6 @@ export declare function stat(path: fs.PathLike, options?: fs.StatOptions): Promi
  * `lstat`.
  * `lstat()` is identical to `stat()`, except that if path is a symbolic link,
  * then the link itself is stat-ed, not the file that it refers to.
- * @param path
- * @return
  */
 export declare function lstat(path: fs.PathLike, options?: {
     bigint?: boolean;
@@ -207,31 +181,20 @@ export declare function lstat(path: fs.PathLike, options?: {
 export declare function lstat(path: fs.PathLike, options: {
     bigint: true;
 }): Promise<BigIntStats>;
-/**
- * `truncate`.
- * @param path
- * @param len
- */
 export declare function truncate(path: fs.PathLike, len?: number): Promise<void>;
-/**
- * `unlink`.
- * @param path
- */
 export declare function unlink(path: fs.PathLike): Promise<void>;
 /**
  * Asynchronous file open.
  * @see http://www.manpagez.com/man/2/open/
- * @param flags Handles the complexity of the various file modes. See its API for more details.
+ * @param flag Handles the complexity of the various file modes. See its API for more details.
  * @param mode Mode to use to open the file. Can be ignored if the filesystem doesn't support permissions.
  */
 export declare function open(path: fs.PathLike, flag?: fs.OpenMode, mode?: fs.Mode): Promise<FileHandle>;
 /**
  * Asynchronously reads the entire contents of a file.
- * @param filename
- * @param options
- * options.encoding The string encoding for the file contents. Defaults to `null`.
- * options.flag Defaults to `'r'`.
- * @returns file data
+ * @option encoding The string encoding for the file contents. Defaults to `null`.
+ * @option flag Defaults to `'r'`.
+ * @returns the file data
  */
 export declare function readFile(path: fs.PathLike | promises.FileHandle, options?: {
     encoding?: null;
@@ -248,12 +211,9 @@ export declare function readFile(path: fs.PathLike | promises.FileHandle, option
  * Asynchronously writes data to a file, replacing the file if it already exists.
  *
  * The encoding option is ignored if data is a buffer.
- * @param path
- * @param data Note:
- * @param _options
- * @option options encoding Defaults to `'utf8'`.
- * @option options mode Defaults to `0644`.
- * @option options flag Defaults to `'w'`.
+ * @option encoding Defaults to `'utf8'`.
+ * @option mode Defaults to `0644`.
+ * @option flag Defaults to `'w'`.
  */
 export declare function writeFile(path: fs.PathLike | promises.FileHandle, data: FileContents | Stream | Iterable<string | ArrayBufferView> | AsyncIterable<string | ArrayBufferView>, _options?: (fs.ObjectEncodingOptions & {
     mode?: fs.Mode;
@@ -261,23 +221,15 @@ export declare function writeFile(path: fs.PathLike | promises.FileHandle, data:
     flush?: boolean;
 }) | BufferEncoding | null): Promise<void>;
 /**
- * Asynchronously append data to a file, creating the file if it not yet
- * exists.
- * @param path
- * @param data
- * @param options
- * @option options encoding Defaults to `'utf8'`.
- * @option options mode Defaults to `0644`.
- * @option options flag Defaults to `'a'`.
+ * Asynchronously append data to a file, creating the file if it not yet exists.
+ * @option encoding Defaults to `'utf8'`.
+ * @option mode Defaults to `0644`.
+ * @option flag Defaults to `'a'`.
  */
 export declare function appendFile(path: fs.PathLike | promises.FileHandle, data: FileContents, _options?: BufferEncoding | (fs.EncodingOption & {
     mode?: fs.Mode;
     flag?: fs.OpenMode;
 }) | null): Promise<void>;
-/**
- * `rmdir`.
- * @param path
- */
 export declare function rmdir(path: fs.PathLike): Promise<void>;
 /**
  * Asynchronous mkdir(2) - create a directory.
@@ -295,7 +247,7 @@ export declare function mkdir(path: fs.PathLike, options?: fs.Mode | fs.MakeDire
 /**
  * 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.
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'`.
  */
 export declare function readdir(path: fs.PathLike, options?: (fs.ObjectEncodingOptions & {
     withFileTypes?: false;
@@ -313,11 +265,6 @@ export declare function readdir(path: fs.PathLike, options: fs.ObjectEncodingOpt
     withFileTypes: true;
     recursive?: boolean;
 }): Promise<Dirent[]>;
-/**
- * `link`.
- * @param targetPath
- * @param linkPath
- */
 export declare function link(targetPath: fs.PathLike, linkPath: fs.PathLike): Promise<void>;
 /**
  * `symlink`.
@@ -326,68 +273,31 @@ export declare function link(targetPath: fs.PathLike, linkPath: fs.PathLike): Pr
  * @param type can be either `'dir'` or `'file'` (default is `'file'`)
  */
 export declare function symlink(target: fs.PathLike, path: fs.PathLike, type?: fs.symlink.Type | string | null): Promise<void>;
-/**
- * readlink.
- * @param path
- */
 export declare function readlink(path: fs.PathLike, options: fs.BufferEncodingOption): Promise<Buffer>;
 export declare function readlink(path: fs.PathLike, options?: fs.EncodingOption | null): Promise<string>;
 export declare function readlink(path: fs.PathLike, options?: fs.BufferEncodingOption | fs.EncodingOption | string | null): Promise<string | Buffer>;
-/**
- * `chown`.
- * @param path
- * @param uid
- * @param gid
- */
 export declare function chown(path: fs.PathLike, uid: number, gid: number): Promise<void>;
-/**
- * `lchown`.
- * @param path
- * @param uid
- * @param gid
- */
 export declare function lchown(path: fs.PathLike, uid: number, gid: number): Promise<void>;
-/**
- * `chmod`.
- * @param path
- * @param mode
- */
 export declare function chmod(path: fs.PathLike, mode: fs.Mode): Promise<void>;
-/**
- * `lchmod`.
- * @param path
- * @param mode
- */
 export declare function lchmod(path: fs.PathLike, mode: fs.Mode): Promise<void>;
 /**
  * Change file timestamps of the file referenced by the supplied path.
- * @param path
- * @param atime
- * @param mtime
  */
 export declare function utimes(path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): Promise<void>;
 /**
  * Change file timestamps of the file referenced by the supplied path.
- * @param path
- * @param atime
- * @param mtime
  */
 export declare function lutimes(path: fs.PathLike, atime: fs.TimeLike, mtime: fs.TimeLike): Promise<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.
+ * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. Defaults to `'utf8'`.
  */
 export declare function realpath(path: fs.PathLike, options: fs.BufferEncodingOption): Promise<Buffer>;
 export declare function realpath(path: fs.PathLike, options?: fs.EncodingOption | BufferEncoding): Promise<string>;
 export declare function watch(filename: fs.PathLike, options?: fs.WatchOptions | BufferEncoding): AsyncIterable<FileChangeInfo<string>>;
 export declare function watch(filename: fs.PathLike, options: fs.WatchOptions | fs.BufferEncodingOption): AsyncIterable<FileChangeInfo<Buffer>>;
 export declare function watch(filename: fs.PathLike, options?: fs.WatchOptions | string): AsyncIterable<FileChangeInfo<string>> | AsyncIterable<FileChangeInfo<Buffer>>;
-/**
- * `access`.
- * @param path
- * @param mode
- */
 export declare function access(path: fs.PathLike, mode?: number): Promise<void>;
 /**
  * Asynchronous `rm`. Removes files or directories (recursively).
@@ -425,15 +335,15 @@ export declare function opendir(path: fs.PathLike, options?: fs.OpenDirOptions):
  * @param opts Options for the copy operation. Currently supports these options from Node.js 'fs.await cp':
  *   * `dereference`: Dereference symbolic links.
  *   * `errorOnExist`: Throw an error if the destination file or directory already exists.
- *   * `filter`: A function that takes a source and destination path and returns a boolean, indicating whether to copy the given source element.
+ *   * `filter`: A function that takes a source and destination path and returns a boolean, indicating whether to copy `source` element.
  *   * `force`: Overwrite the destination if it exists, and overwrite existing readonly destination files.
  *   * `preserveTimestamps`: Preserve file timestamps.
  *   * `recursive`: If `true`, copies directories recursively.
  */
 export declare function cp(source: fs.PathLike, destination: fs.PathLike, opts?: fs.CopyOptions): Promise<void>;
 /**
- * @since v18.15.0
- * @return Fulfills with an {fs.StatFs} for the file system.
+ * @since Node v18.15.0
+ * @returns Fulfills with an {fs.StatFs} for the file system.
  */
 export declare function statfs(path: fs.PathLike, opts?: fs.StatFsOptions & {
     bigint?: false;