@zenfs/core 1.3.6 → 1.4.0

package/dist/emulation/promises.d.ts

@@ -4,6 +4,7 @@ import type * as promises from 'node:fs/promises';
 import type { Stream } from 'node:stream';
 import type { ReadableStream as TReadableStream } from 'node:stream/web';
 import type { Interface as ReadlineInterface } from 'readline';
+import type { V_Context } from '../context.js';
 import type { File } from '../file.js';
 import type { FileContents } from '../filesystem.js';
 import '../polyfills.js';
@@ -13,6 +14,7 @@ import { type InternalOptions, type ReaddirOptions } from './shared.js';
 import { ReadStream, WriteStream } from './streams.js';
 export * as constants from './constants.js';
 export declare class FileHandle implements promises.FileHandle {
+    protected context?: V_Context | undefined;
     /**
      * The file descriptor for this file handle.
      */
@@ -22,7 +24,7 @@ export declare class FileHandle implements promises.FileHandle {
      * The file for this file handle
      */
     readonly file: File;
-    constructor(fdOrFile: number | File);
+    constructor(fdOrFile: number | File, context?: V_Context | undefined);
     /**
      * Asynchronous fchown(2) - Change ownership of a file.
      */
@@ -163,51 +165,51 @@ export declare class FileHandle implements promises.FileHandle {
      */
     createWriteStream(options?: promises.CreateWriteStreamOptions): WriteStream;
 }
-export declare function rename(oldPath: fs.PathLike, newPath: fs.PathLike): Promise<void>;
+export declare function rename(this: V_Context, oldPath: fs.PathLike, newPath: fs.PathLike): Promise<void>;
 /**
  * Test whether or not `path` exists by checking with the file system.
  */
-export declare function exists(path: fs.PathLike): Promise<boolean>;
-export declare function stat(path: fs.PathLike, options: fs.BigIntOptions): Promise<BigIntStats>;
-export declare function stat(path: fs.PathLike, options?: {
+export declare function exists(this: V_Context, path: fs.PathLike): Promise<boolean>;
+export declare function stat(this: V_Context, path: fs.PathLike, options: fs.BigIntOptions): Promise<BigIntStats>;
+export declare function stat(this: V_Context, path: fs.PathLike, options?: {
     bigint?: false;
 }): Promise<Stats>;
-export declare function stat(path: fs.PathLike, options?: fs.StatOptions): Promise<Stats | BigIntStats>;
+export declare function stat(this: V_Context, path: fs.PathLike, options?: fs.StatOptions): Promise<Stats | BigIntStats>;
 /**
  * `lstat`.
  * `lstat()` is identical to `stat()`, except that if path is a symbolic link,
  * then the link itself is stat-ed, not the file that it refers to.
  */
-export declare function lstat(path: fs.PathLike, options?: {
+export declare function lstat(this: V_Context, path: fs.PathLike, options?: {
     bigint?: boolean;
 }): Promise<Stats>;
-export declare function lstat(path: fs.PathLike, options: {
+export declare function lstat(this: V_Context, path: fs.PathLike, options: {
     bigint: true;
 }): Promise<BigIntStats>;
-export declare function truncate(path: fs.PathLike, len?: number): Promise<void>;
-export declare function unlink(path: fs.PathLike): Promise<void>;
+export declare function truncate(this: V_Context, path: fs.PathLike, len?: number): Promise<void>;
+export declare function unlink(this: V_Context, path: fs.PathLike): Promise<void>;
 /**
  * Asynchronous file open.
  * @see http://www.manpagez.com/man/2/open/
  * @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>;
+export declare function open(this: V_Context, path: fs.PathLike, flag?: fs.OpenMode, mode?: fs.Mode): Promise<FileHandle>;
 /**
  * Asynchronously reads the entire contents of a file.
  * @option encoding The string encoding for the file contents. Defaults to `null`.
  * @option flag Defaults to `'r'`.
  * @returns the file data
  */
-export declare function readFile(path: fs.PathLike | promises.FileHandle, options?: {
+export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options?: {
     encoding?: null;
     flag?: fs.OpenMode;
 } | null): Promise<Buffer>;
-export declare function readFile(path: fs.PathLike | promises.FileHandle, options: {
+export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options: {
     encoding: BufferEncoding;
     flag?: fs.OpenMode;
 } | BufferEncoding): Promise<string>;
-export declare function readFile(path: fs.PathLike | promises.FileHandle, options?: (fs.ObjectEncodingOptions & {
+export declare function readFile(this: V_Context, path: fs.PathLike | promises.FileHandle, options?: (fs.ObjectEncodingOptions & {
     flag?: fs.OpenMode;
 }) | BufferEncoding | null): Promise<string | Buffer>;
 /**
@@ -218,7 +220,7 @@ export declare function readFile(path: fs.PathLike | promises.FileHandle, option
  * @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 & {
+export declare function writeFile(this: V_Context, path: fs.PathLike | promises.FileHandle, data: FileContents | Stream | Iterable<string | ArrayBufferView> | AsyncIterable<string | ArrayBufferView>, _options?: (fs.ObjectEncodingOptions & {
     mode?: fs.Mode;
     flag?: fs.OpenMode;
     flush?: boolean;
@@ -229,24 +231,24 @@ export declare function writeFile(path: fs.PathLike | promises.FileHandle, data:
  * @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 & {
+export declare function appendFile(this: V_Context, path: fs.PathLike | promises.FileHandle, data: FileContents, _options?: BufferEncoding | (fs.EncodingOption & {
     mode?: fs.Mode;
     flag?: fs.OpenMode;
 }) | null): Promise<void>;
-export declare function rmdir(path: fs.PathLike): Promise<void>;
+export declare function rmdir(this: V_Context, path: fs.PathLike): 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`.
  */
-export declare function mkdir(path: fs.PathLike, options: fs.MakeDirectoryOptions & {
+export declare function mkdir(this: V_Context, path: fs.PathLike, options: fs.MakeDirectoryOptions & {
     recursive: true;
 }): Promise<string | undefined>;
-export declare function mkdir(path: fs.PathLike, options?: fs.Mode | (fs.MakeDirectoryOptions & {
+export declare function mkdir(this: V_Context, path: fs.PathLike, options?: fs.Mode | (fs.MakeDirectoryOptions & {
     recursive?: false | undefined;
 }) | null): Promise<void>;
-export declare function mkdir(path: fs.PathLike, options?: fs.Mode | fs.MakeDirectoryOptions | null): Promise<string | undefined>;
+export declare function mkdir(this: V_Context, path: fs.PathLike, options?: fs.Mode | fs.MakeDirectoryOptions | null): Promise<string | undefined>;
 /**
  * Asynchronous readdir(3) - read a directory.
  *
@@ -254,67 +256,67 @@ export declare function mkdir(path: fs.PathLike, options?: fs.Mode | fs.MakeDire
  * @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
  * @param options The encoding (or an object specifying the encoding), used as the encoding of the result. If not provided, `'utf8'`.
  */
-export declare function readdir(path: fs.PathLike, options?: (fs.ObjectEncodingOptions & ReaddirOptions & {
+export declare function readdir(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & ReaddirOptions & {
     withFileTypes?: false;
 }) | BufferEncoding | null): Promise<string[]>;
-export declare function readdir(path: fs.PathLike, options: fs.BufferEncodingOption & ReaddirOptions & {
+export declare function readdir(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption & ReaddirOptions & {
     withFileTypes?: false;
 }): Promise<Buffer[]>;
-export declare function readdir(path: fs.PathLike, options?: (fs.ObjectEncodingOptions & ReaddirOptions & {
+export declare function readdir(this: V_Context, path: fs.PathLike, options?: (fs.ObjectEncodingOptions & ReaddirOptions & {
     withFileTypes?: false;
 }) | BufferEncoding | null): Promise<string[] | Buffer[]>;
-export declare function readdir(path: fs.PathLike, options: fs.ObjectEncodingOptions & ReaddirOptions & {
+export declare function readdir(this: V_Context, path: fs.PathLike, options: fs.ObjectEncodingOptions & ReaddirOptions & {
     withFileTypes: true;
 }): Promise<Dirent[]>;
-export declare function readdir(path: fs.PathLike, options?: (ReaddirOptions & (fs.ObjectEncodingOptions | fs.BufferEncodingOption)) | BufferEncoding | null): Promise<string[] | Dirent[] | Buffer[]>;
-export declare function link(targetPath: fs.PathLike, linkPath: fs.PathLike): Promise<void>;
+export declare function readdir(this: V_Context, path: fs.PathLike, options?: (ReaddirOptions & (fs.ObjectEncodingOptions | fs.BufferEncodingOption)) | BufferEncoding | null): Promise<string[] | Dirent[] | Buffer[]>;
+export declare function link(this: V_Context, targetPath: fs.PathLike, linkPath: fs.PathLike): Promise<void>;
 /**
  * `symlink`.
  * @param target target path
  * @param path link path
  * @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>;
-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>;
-export declare function chown(path: fs.PathLike, uid: number, gid: number): Promise<void>;
-export declare function lchown(path: fs.PathLike, uid: number, gid: number): Promise<void>;
-export declare function chmod(path: fs.PathLike, mode: fs.Mode): Promise<void>;
-export declare function lchmod(path: fs.PathLike, mode: fs.Mode): Promise<void>;
+export declare function symlink(this: V_Context, target: fs.PathLike, path: fs.PathLike, type?: fs.symlink.Type | string | null): Promise<void>;
+export declare function readlink(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption): Promise<Buffer>;
+export declare function readlink(this: V_Context, path: fs.PathLike, options?: fs.EncodingOption | null): Promise<string>;
+export declare function readlink(this: V_Context, path: fs.PathLike, options?: fs.BufferEncodingOption | fs.EncodingOption | string | null): Promise<string | Buffer>;
+export declare function chown(this: V_Context, path: fs.PathLike, uid: number, gid: number): Promise<void>;
+export declare function lchown(this: V_Context, path: fs.PathLike, uid: number, gid: number): Promise<void>;
+export declare function chmod(this: V_Context, path: fs.PathLike, mode: fs.Mode): Promise<void>;
+export declare function lchmod(this: V_Context, path: fs.PathLike, mode: fs.Mode): Promise<void>;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  */
-export declare function utimes(path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): Promise<void>;
+export declare function utimes(this: V_Context, path: fs.PathLike, atime: string | number | Date, mtime: string | number | Date): Promise<void>;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  */
-export declare function lutimes(path: fs.PathLike, atime: fs.TimeLike, mtime: fs.TimeLike): Promise<void>;
+export declare function lutimes(this: V_Context, 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. Defaults to `'utf8'`.
  * @todo handle options
  */
-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 realpath(this: V_Context, path: fs.PathLike, options: fs.BufferEncodingOption): Promise<Buffer>;
+export declare function realpath(this: V_Context, path: fs.PathLike, options?: fs.EncodingOption | BufferEncoding): Promise<string>;
 export declare function watch(filename: fs.PathLike, options?: fs.WatchOptions | BufferEncoding): AsyncIterable<promises.FileChangeInfo<string>>;
 export declare function watch(filename: fs.PathLike, options: fs.WatchOptions | fs.BufferEncodingOption): AsyncIterable<promises.FileChangeInfo<Buffer>>;
 export declare function watch(filename: fs.PathLike, options?: fs.WatchOptions | string): AsyncIterable<promises.FileChangeInfo<string>> | AsyncIterable<promises.FileChangeInfo<Buffer>>;
-export declare function access(path: fs.PathLike, mode?: number): Promise<void>;
+export declare function access(this: V_Context, path: fs.PathLike, mode?: number): Promise<void>;
 /**
  * Asynchronous `rm`. Removes files or directories (recursively).
  * @param path The path to the file or directory to remove.
  */
-export declare function rm(path: fs.PathLike, options?: fs.RmOptions & InternalOptions): Promise<void>;
+export declare function rm(this: V_Context, path: fs.PathLike, options?: fs.RmOptions & InternalOptions): Promise<void>;
 /**
  * Asynchronous `mkdtemp`. Creates a unique temporary directory.
  * @param prefix The directory prefix.
  * @param options The encoding (or an object including `encoding`).
  * @returns The path to the created temporary directory, encoded as a string or buffer.
  */
-export declare function mkdtemp(prefix: string, options?: fs.EncodingOption): Promise<string>;
-export declare function mkdtemp(prefix: string, options?: fs.BufferEncodingOption): Promise<Buffer>;
+export declare function mkdtemp(this: V_Context, prefix: string, options?: fs.EncodingOption): Promise<string>;
+export declare function mkdtemp(this: V_Context, prefix: string, options?: fs.BufferEncodingOption): Promise<Buffer>;
 /**
  * Asynchronous `copyFile`. Copies a file.
  * @param src The source file.
@@ -322,7 +324,7 @@ export declare function mkdtemp(prefix: string, options?: fs.BufferEncodingOptio
  * @param mode Optional flags for the copy operation. Currently supports these flags:
  *    * `fs.constants.COPYFILE_EXCL`: If the destination file already exists, the operation fails.
  */
-export declare function copyFile(src: fs.PathLike, dest: fs.PathLike, mode?: number): Promise<void>;
+export declare function copyFile(this: V_Context, src: fs.PathLike, dest: fs.PathLike, mode?: number): Promise<void>;
 /**
  * Asynchronous `opendir`. Opens a directory.
  * @param path The path to the directory.
@@ -330,7 +332,7 @@ export declare function copyFile(src: fs.PathLike, dest: fs.PathLike, mode?: num
  * @returns A `Dir` object representing the opened directory.
  * @todo Use options
  */
-export declare function opendir(path: fs.PathLike, options?: fs.OpenDirOptions): Promise<Dir>;
+export declare function opendir(this: V_Context, path: fs.PathLike, options?: fs.OpenDirOptions): Promise<Dir>;
 /**
  * Asynchronous `cp`. Recursively copies a file or directory.
  * @param source The source file or directory.
@@ -343,15 +345,15 @@ export declare function opendir(path: fs.PathLike, options?: fs.OpenDirOptions):
  *   * `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>;
+export declare function cp(this: V_Context, source: fs.PathLike, destination: fs.PathLike, opts?: fs.CopyOptions): Promise<void>;
 /**
  * @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 & {
+export declare function statfs(this: V_Context, path: fs.PathLike, opts?: fs.StatFsOptions & {
     bigint?: false;
 }): Promise<fs.StatsFs>;
-export declare function statfs(path: fs.PathLike, opts: fs.StatFsOptions & {
+export declare function statfs(this: V_Context, path: fs.PathLike, opts: fs.StatFsOptions & {
     bigint: true;
 }): Promise<fs.BigIntStatsFs>;
-export declare function statfs(path: fs.PathLike, opts?: fs.StatFsOptions): Promise<fs.StatsFs | fs.BigIntStatsFs>;
+export declare function statfs(this: V_Context, path: fs.PathLike, opts?: fs.StatFsOptions): Promise<fs.StatsFs | fs.BigIntStatsFs>;