@zenfs/core 0.0.12 → 0.2.0

package/dist/emulation/callbacks.d.ts

@@ -1,8 +1,11 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
-import type { FSWatcher, ReadStream, WriteStream, symlink as _symlink } from 'fs';
-import { BFSCallback, BFSOneArgCallback, BFSThreeArgCallback, FileContents } from '../filesystem.js';
-import { Stats } from '../stats.js';
+import type * as Node from 'fs';
+import { TwoArgCallback, NoArgCallback, ThreeArgCallback, FileContents } from '../filesystem.js';
+import { BigIntStats, Stats } from '../stats.js';
+import { PathLike } from './shared.js';
+import { ReadStream, WriteStream } from './streams.js';
+import { Dirent } from './dir.js';
 /**
  * Asynchronous rename. No arguments other than a possible exception are given
  * to the completion callback.
@@ -10,24 +13,27 @@ import { Stats } from '../stats.js';
  * @param newPath
  * @param callback
  */
-export declare function rename(oldPath: string, newPath: string, cb?: BFSOneArgCallback): void;
+export declare function rename(oldPath: PathLike, newPath: PathLike, cb?: NoArgCallback): void;
 /**
  * Test whether or not the given path exists by checking with the file system.
  * Then call the callback argument with either true or false.
- * @example Sample invocation
- *   fs.exists('/etc/passwd', function (exists) {
- *     util.debug(exists ? "it's there" : "no passwd!");
- *   });
  * @param path
  * @param callback
  */
-export declare function exists(path: string, cb?: (exists: boolean) => unknown): void;
+export declare function exists(path: PathLike, cb?: (exists: boolean) => unknown): void;
 /**
  * Asynchronous `stat`.
  * @param path
  * @param callback
  */
-export declare function stat(path: string, cb?: BFSCallback<Stats>): void;
+export declare function stat(path: PathLike, callback: TwoArgCallback<Stats>): void;
+export declare function stat(path: PathLike, options: Node.StatOptions & {
+    bigint?: false;
+}, callback: TwoArgCallback<Stats>): void;
+export declare function stat(path: PathLike, options: Node.StatOptions & {
+    bigint: true;
+}, callback: TwoArgCallback<BigIntStats>): void;
+export declare function stat(path: PathLike, options: Node.StatOptions, callback: TwoArgCallback<Stats | BigIntStats>): void;
 /**
  * Asynchronous `lstat`.
  * `lstat()` is identical to `stat()`, except that if path is a symbolic link,
@@ -35,21 +41,28 @@ export declare function stat(path: string, cb?: BFSCallback<Stats>): void;
  * @param path
  * @param callback
  */
-export declare function lstat(path: string, cb?: BFSCallback<Stats>): void;
+export declare function lstat(path: PathLike, callback: TwoArgCallback<Stats>): void;
+export declare function lstat(path: PathLike, options: Node.StatOptions & {
+    bigint?: false;
+}, callback: TwoArgCallback<Stats>): void;
+export declare function lstat(path: PathLike, options: Node.StatOptions & {
+    bigint: true;
+}, callback: TwoArgCallback<BigIntStats>): void;
+export declare function lstat(path: PathLike, options: Node.StatOptions, callback: TwoArgCallback<Stats | BigIntStats>): void;
 /**
  * Asynchronous `truncate`.
  * @param path
  * @param len
  * @param callback
  */
-export declare function truncate(path: string, cb?: BFSOneArgCallback): void;
-export declare function truncate(path: string, len: number, cb?: BFSOneArgCallback): void;
+export declare function truncate(path: PathLike, cb?: NoArgCallback): void;
+export declare function truncate(path: PathLike, len: number, cb?: NoArgCallback): void;
 /**
  * Asynchronous `unlink`.
  * @param path
  * @param callback
  */
-export declare function unlink(path: string, cb?: BFSOneArgCallback): void;
+export declare function unlink(path: PathLike, cb?: NoArgCallback): void;
 /**
  * Asynchronous file open.
  * Exclusive mode ensures that path is newly created.
@@ -75,80 +88,60 @@ export declare function unlink(path: string, cb?: BFSOneArgCallback): void;
  * @param mode defaults to `0644`
  * @param callback
  */
-export declare function open(path: string, flag: string, cb?: BFSCallback<number>): void;
-export declare function open(path: string, flag: string, mode: number | string, cb?: BFSCallback<number>): void;
+export declare function open(path: PathLike, flag: string, cb?: TwoArgCallback<number>): void;
+export declare function open(path: PathLike, flag: string, mode: number | string, cb?: TwoArgCallback<number>): void;
 /**
  * Asynchronously reads the entire contents of a file.
- * @example Usage example
- *   fs.readFile('/etc/passwd', function (err, data) {
- *     if (err) throw err;
- *     console.log(data);
- *   });
  * @param filename
  * @param options
- * @option options [String] encoding The string encoding for the file contents. Defaults to `null`.
- * @option options [String] flag Defaults to `'r'`.
+ * @option options encoding The string encoding for the file contents. Defaults to `null`.
+ * @option options flag Defaults to `'r'`.
  * @param callback If no encoding is specified, then the raw buffer is returned.
  */
-export declare function readFile(filename: string, cb: BFSCallback<Uint8Array>): void;
-export declare function readFile(filename: string, options: {
+export declare function readFile(filename: PathLike, cb: TwoArgCallback<Uint8Array>): void;
+export declare function readFile(filename: PathLike, options: {
     flag?: string;
-}, callback?: BFSCallback<Uint8Array>): void;
-export declare function readFile(filename: string, options: {
-    encoding: string;
+}, callback?: TwoArgCallback<Uint8Array>): void;
+export declare function readFile(filename: PathLike, optios: {
+    encoding: BufferEncoding;
     flag?: string;
-}, callback?: BFSCallback<string>): void;
-export declare function readFile(filename: string, encoding: string, cb: BFSCallback<string>): void;
+} | BufferEncoding, cb: TwoArgCallback<string>): void;
 /**
  * Asynchronously writes data to a file, replacing the file if it already
  * exists.
  *
  * The encoding option is ignored if data is a buffer.
  *
- * @example Usage example
- *   fs.writeFile('message.txt', 'Hello Node', function (err) {
- *     if (err) throw err;
- *     console.log('It\'s saved!');
- *   });
  * @param filename
  * @param data
  * @param options
- * @option options [String] encoding Defaults to `'utf8'`.
- * @option options [Number] mode Defaults to `0644`.
- * @option options [String] flag Defaults to `'w'`.
+ * @option encoding Defaults to `'utf8'`.
+ * @option mode Defaults to `0644`.
+ * @option flag Defaults to `'w'`.
  * @param callback
  */
-export declare function writeFile(filename: string, data: FileContents, cb?: BFSOneArgCallback): void;
-export declare function writeFile(filename: string, data: FileContents, encoding?: string, cb?: BFSOneArgCallback): void;
-export declare function writeFile(filename: string, data: FileContents, options?: {
-    encoding?: string;
-    mode?: string | number;
-    flag?: string;
-}, cb?: BFSOneArgCallback): void;
+export declare function writeFile(filename: PathLike, data: FileContents, cb?: NoArgCallback): void;
+export declare function writeFile(filename: PathLike, data: FileContents, encoding?: BufferEncoding, cb?: NoArgCallback): void;
+export declare function writeFile(filename: PathLike, data: FileContents, options?: Node.WriteFileOptions, cb?: NoArgCallback): void;
 /**
  * Asynchronously append data to a file, creating the file if it not yet
  * exists.
  *
- * @example Usage example
- *   fs.appendFile('message.txt', 'data to append', function (err) {
- *     if (err) throw err;
- *     console.log('The "data to append" was appended to file!');
- *   });
  * @param filename
  * @param data
  * @param options
- * @option options [String] encoding Defaults to `'utf8'`.
- * @option options [Number] mode Defaults to `0644`.
- * @option options [String] flag Defaults to `'a'`.
+ * @option encoding Defaults to `'utf8'`.
+ * @option mode Defaults to `0644`.
+ * @option flag Defaults to `'a'`.
  * @param callback
  */
-export declare function appendFile(filename: string, data: FileContents, cb?: BFSOneArgCallback): void;
-export declare function appendFile(filename: string, data: FileContents, options?: {
+export declare function appendFile(filename: PathLike, data: FileContents, cb?: NoArgCallback): void;
+export declare function appendFile(filename: PathLike, data: FileContents, options?: {
     encoding?: string;
     mode?: number | string;
     flag?: string;
-}, cb?: BFSOneArgCallback): void;
-export declare function appendFile(filename: string, data: FileContents, encoding?: string, cb?: BFSOneArgCallback): void;
+}, cb?: NoArgCallback): void;
+export declare function appendFile(filename: PathLike, data: FileContents, encoding?: string, cb?: NoArgCallback): void;
 /**
  * Asynchronous `fstat`.
  * `fstat()` is identical to `stat()`, except that the file to be stat-ed is
@@ -156,33 +149,39 @@ export declare function appendFile(filename: string, data: FileContents, encodin
  * @param fd
  * @param callback
  */
-export declare function fstat(fd: number, cb?: BFSCallback<Stats>): void;
+export declare function fstat(fd: number, cb: TwoArgCallback<Stats>): void;
+export declare function fstat(fd: number, options: Node.StatOptions & {
+    bigint?: false;
+}, cb: TwoArgCallback<Stats>): void;
+export declare function fstat(fd: number, options: Node.StatOptions & {
+    bigint: true;
+}, cb: TwoArgCallback<BigIntStats>): void;
 /**
  * Asynchronous close.
  * @param fd
  * @param callback
  */
-export declare function close(fd: number, cb?: BFSOneArgCallback): void;
+export declare function close(fd: number, cb?: NoArgCallback): void;
 /**
  * Asynchronous ftruncate.
  * @param fd
  * @param len
  * @param callback
  */
-export declare function ftruncate(fd: number, cb?: BFSOneArgCallback): void;
-export declare function ftruncate(fd: number, len?: number, cb?: BFSOneArgCallback): void;
+export declare function ftruncate(fd: number, cb?: NoArgCallback): void;
+export declare function ftruncate(fd: number, len?: number, cb?: NoArgCallback): void;
 /**
  * Asynchronous fsync.
  * @param fd
  * @param callback
  */
-export declare function fsync(fd: number, cb?: BFSOneArgCallback): void;
+export declare function fsync(fd: number, cb?: NoArgCallback): void;
 /**
  * Asynchronous fdatasync.
  * @param fd
  * @param callback
  */
-export declare function fdatasync(fd: number, cb?: BFSOneArgCallback): void;
+export declare function fdatasync(fd: number, cb?: NoArgCallback): void;
 /**
  * Write buffer to the file specified by `fd`.
  * Note that it is unsafe to use fs.write multiple times on the same file
@@ -197,11 +196,11 @@ export declare function fdatasync(fd: number, cb?: BFSOneArgCallback): void;
  *   the current position.
  * @param callback The number specifies the number of bytes written into the file.
  */
-export declare function write(fd: number, buffer: Uint8Array, offset: number, length: number, cb?: BFSThreeArgCallback<number, Uint8Array>): void;
-export declare function write(fd: number, buffer: Uint8Array, offset: number, length: number, position: number | null, cb?: BFSThreeArgCallback<number, Uint8Array>): void;
-export declare function write(fd: number, data: FileContents, cb?: BFSThreeArgCallback<number, string>): void;
-export declare function write(fd: number, data: FileContents, position: number | null, cb?: BFSThreeArgCallback<number, string>): void;
-export declare function write(fd: number, data: FileContents, position: number | null, encoding: BufferEncoding, cb?: BFSThreeArgCallback<number, string>): void;
+export declare function write(fd: number, buffer: Uint8Array, offset: number, length: number, cb?: ThreeArgCallback<number, Uint8Array>): void;
+export declare function write(fd: number, buffer: Uint8Array, offset: number, length: number, position: number | null, cb?: ThreeArgCallback<number, Uint8Array>): void;
+export declare function write(fd: number, data: FileContents, cb?: ThreeArgCallback<number, string>): void;
+export declare function write(fd: number, data: FileContents, position: number | null, cb?: ThreeArgCallback<number, string>): void;
+export declare function write(fd: number, data: FileContents, position: number | null, encoding: BufferEncoding, cb?: ThreeArgCallback<number, string>): void;
 /**
  * Read data from the file specified by `fd`.
  * @param buffer The buffer that the data will be
@@ -214,7 +213,7 @@ export declare function write(fd: number, data: FileContents, position: number |
  *   position.
  * @param callback The number is the number of bytes read
  */
-export declare function read(fd: number, buffer: Uint8Array, offset: number, length: number, position?: number, cb?: BFSThreeArgCallback<number, Uint8Array>): void;
+export declare function read(fd: number, buffer: Uint8Array, offset: number, length: number, position?: number, cb?: ThreeArgCallback<number, Uint8Array>): void;
 /**
  * Asynchronous `fchown`.
  * @param fd
@@ -222,14 +221,14 @@ export declare function read(fd: number, buffer: Uint8Array, offset: number, len
  * @param gid
  * @param callback
  */
-export declare function fchown(fd: number, uid: number, gid: number, cb?: BFSOneArgCallback): void;
+export declare function fchown(fd: number, uid: number, gid: number, cb?: NoArgCallback): void;
 /**
  * Asynchronous `fchmod`.
  * @param fd
  * @param mode
  * @param callback
  */
-export declare function fchmod(fd: number, mode: string | number, cb: BFSOneArgCallback): void;
+export declare function fchmod(fd: number, mode: string | number, cb: NoArgCallback): void;
 /**
  * Change the file timestamps of a file referenced by the supplied file
  * descriptor.
@@ -238,20 +237,20 @@ export declare function fchmod(fd: number, mode: string | number, cb: BFSOneArgC
  * @param mtime
  * @param callback
  */
-export declare function futimes(fd: number, atime: number | Date, mtime: number | Date, cb?: BFSOneArgCallback): void;
+export declare function futimes(fd: number, atime: number | Date, mtime: number | Date, cb?: NoArgCallback): void;
 /**
  * Asynchronous `rmdir`.
  * @param path
  * @param callback
  */
-export declare function rmdir(path: string, cb?: BFSOneArgCallback): void;
+export declare function rmdir(path: PathLike, cb?: NoArgCallback): void;
 /**
  * Asynchronous `mkdir`.
  * @param path
  * @param mode defaults to `0777`
  * @param callback
  */
-export declare function mkdir(path: string, mode?: any, cb?: BFSOneArgCallback): void;
+export declare function mkdir(path: PathLike, mode?: Node.Mode, cb?: NoArgCallback): void;
 /**
  * Asynchronous `readdir`. Reads the contents of a directory.
  * The callback gets two arguments `(err, files)` where `files` is an array of
@@ -259,29 +258,38 @@ export declare function mkdir(path: string, mode?: any, cb?: BFSOneArgCallback):
  * @param path
  * @param callback
  */
-export declare function readdir(path: string, cb?: BFSCallback<string[]>): void;
+export declare function readdir(path: PathLike, cb: TwoArgCallback<string[]>): void;
+export declare function readdir(path: PathLike, options: {
+    withFileTypes?: false;
+}, cb: TwoArgCallback<string[]>): void;
+export declare function readdir(path: PathLike, options: {
+    withFileTypes: true;
+}, cb: TwoArgCallback<Dirent[]>): void;
 /**
  * Asynchronous `link`.
- * @param srcpath
- * @param dstpath
+ * @param existing
+ * @param newpath
  * @param callback
  */
-export declare function link(srcpath: string, dstpath: string, cb?: BFSOneArgCallback): void;
+export declare function link(existing: PathLike, newpath: PathLike, cb?: NoArgCallback): void;
 /**
  * Asynchronous `symlink`.
- * @param srcpath
- * @param dstpath
+ * @param target target path
+ * @param path link path
  * @param type can be either `'dir'` or `'file'` (default is `'file'`)
  * @param callback
  */
-export declare function symlink(srcpath: string, dstpath: string, cb?: BFSOneArgCallback): void;
-export declare function symlink(srcpath: string, dstpath: string, type?: _symlink.Type, cb?: BFSOneArgCallback): void;
+export declare function symlink(target: PathLike, path: PathLike, cb?: NoArgCallback): void;
+export declare function symlink(target: PathLike, path: PathLike, type?: Node.symlink.Type, cb?: NoArgCallback): void;
 /**
  * Asynchronous readlink.
  * @param path
  * @param callback
  */
-export declare function readlink(path: string, cb?: BFSCallback<string>): void;
+export declare function readlink(path: PathLike, callback: TwoArgCallback<string> & any): void;
+export declare function readlink(path: PathLike, options: Node.BufferEncodingOption, callback: TwoArgCallback<Uint8Array>): void;
+export declare function readlink(path: PathLike, options: Node.BaseEncodingOptions | string, callback: TwoArgCallback<string | Uint8Array>): void;
+export declare function readlink(path: PathLike, options: Node.BaseEncodingOptions | BufferEncoding, callback: TwoArgCallback<string>): void;
 /**
  * Asynchronous `chown`.
  * @param path
@@ -289,7 +297,7 @@ export declare function readlink(path: string, cb?: BFSCallback<string>): void;
  * @param gid
  * @param callback
  */
-export declare function chown(path: string, uid: number, gid: number, cb?: BFSOneArgCallback): void;
+export declare function chown(path: PathLike, uid: number, gid: number, cb?: NoArgCallback): void;
 /**
  * Asynchronous `lchown`.
  * @param path
@@ -297,21 +305,21 @@ export declare function chown(path: string, uid: number, gid: number, cb?: BFSOn
  * @param gid
  * @param callback
  */
-export declare function lchown(path: string, uid: number, gid: number, cb?: BFSOneArgCallback): void;
+export declare function lchown(path: PathLike, uid: number, gid: number, cb?: NoArgCallback): void;
 /**
  * Asynchronous `chmod`.
  * @param path
  * @param mode
  * @param callback
  */
-export declare function chmod(path: string, mode: number | string, cb?: BFSOneArgCallback): void;
+export declare function chmod(path: PathLike, mode: number | string, cb?: NoArgCallback): void;
 /**
  * Asynchronous `lchmod`.
  * @param path
  * @param mode
  * @param callback
  */
-export declare function lchmod(path: string, mode: number | string, cb?: BFSOneArgCallback): void;
+export declare function lchmod(path: PathLike, mode: number | string, cb?: NoArgCallback): void;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  * @param path
@@ -319,7 +327,7 @@ export declare function lchmod(path: string, mode: number | string, cb?: BFSOneA
  * @param mtime
  * @param callback
  */
-export declare function utimes(path: string, atime: number | Date, mtime: number | Date, cb?: BFSOneArgCallback): void;
+export declare function utimes(path: PathLike, atime: number | Date, mtime: number | Date, cb?: NoArgCallback): void;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  * @param path
@@ -327,56 +335,54 @@ export declare function utimes(path: string, atime: number | Date, mtime: number
  * @param mtime
  * @param callback
  */
-export declare function lutimes(path: string, atime: number | Date, mtime: number | Date, cb?: BFSOneArgCallback): void;
+export declare function lutimes(path: PathLike, atime: number | Date, mtime: number | Date, cb?: NoArgCallback): void;
 /**
  * Asynchronous `realpath`. The callback gets two arguments
  * `(err, resolvedPath)`. May use `process.cwd` to resolve relative paths.
  *
- * @example Usage example
- *   let cache = {'/etc':'/private/etc'};
- *   fs.realpath('/etc/passwd', cache, function (err, resolvedPath) {
- *     if (err) throw err;
- *     console.log(resolvedPath);
- *   });
- *
  * @param path
- * @param cache An object literal of mapped paths that can be used to
- *   force a specific path resolution or avoid additional `fs.stat` calls for
- *   known real paths.
  * @param callback
  */
-export declare function realpath(path: string, cb?: BFSCallback<string>): void;
-export declare function realpath(path: string, cache: {
-    [path: string]: string;
-}, cb: BFSCallback<string>): void;
+export declare function realpath(path: PathLike, cb?: TwoArgCallback<string>): void;
+export declare function realpath(path: PathLike, options: Node.BaseEncodingOptions, cb: TwoArgCallback<string>): void;
 /**
  * Asynchronous `access`.
  * @param path
  * @param mode
  * @param callback
  */
-export declare function access(path: string, cb: BFSOneArgCallback): void;
-export declare function access(path: string, mode: number, cb: BFSOneArgCallback): void;
-export declare function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): void;
-export declare function watchFile(filename: string, options: {
+export declare function access(path: PathLike, cb: NoArgCallback): void;
+export declare function access(path: PathLike, mode: number, cb: NoArgCallback): void;
+export declare function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): void;
+export declare function watchFile(filename: PathLike, options: {
     persistent?: boolean;
     interval?: number;
 }, listener: (curr: Stats, prev: Stats) => void): void;
-export declare function unwatchFile(filename: string, listener?: (curr: Stats, prev: Stats) => void): void;
-export declare function watch(filename: string, listener?: (event: string, filename: string) => any): FSWatcher;
-export declare function watch(filename: string, options: {
+export declare function unwatchFile(filename: PathLike, listener?: (curr: Stats, prev: Stats) => void): void;
+export declare function watch(filename: PathLike, listener?: (event: string, filename: string) => any): Node.FSWatcher;
+export declare function watch(filename: PathLike, options: {
     persistent?: boolean;
-}, listener?: (event: string, filename: string) => any): FSWatcher;
-export declare function createReadStream(path: string, options?: {
+}, listener?: (event: string, filename: string) => any): Node.FSWatcher;
+export declare function createReadStream(path: PathLike, options?: {
     flags?: string;
     encoding?: string;
     fd?: number;
     mode?: number;
     autoClose?: boolean;
 }): ReadStream;
-export declare function createWriteStream(path: string, options?: {
+export declare function createWriteStream(path: PathLike, options?: {
     flags?: string;
     encoding?: string;
     fd?: number;
     mode?: number;
 }): WriteStream;
+export declare function rm(path: PathLike): void;
+export declare function mkdtemp(path: PathLike): void;
+export declare function copyFile(src: PathLike, dest: PathLike, callback: NoArgCallback): void;
+export declare function copyFile(src: PathLike, dest: PathLike, flags: number, callback: NoArgCallback): void;
+export declare function readv(path: PathLike): void;
+type writevCallback = ThreeArgCallback<number, Uint8Array[]>;
+export declare function writev(fd: number, buffers: Uint8Array[], cb: writevCallback): void;
+export declare function writev(fd: number, buffers: Uint8Array[], position: number, cb: writevCallback): void;
+export declare function opendir(path: PathLike): void;
+export {};