@zenfs/core 0.5.4 → 0.5.6

package/dist/emulation/promises.d.ts

@@ -1,13 +1,21 @@
 /// <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 Node from 'node:fs';
-export * as constants from './constants.js';
-import type { PathLike, BufferToUint8Array } from './shared.js';
+import type * as promises from 'node:fs/promises';
+import type { CreateReadStreamOptions, CreateWriteStreamOptions, FileChangeInfo, FileReadResult, FlagAndOpenMode } from 'node:fs/promises';
 import { FileContents } from '../filesystem.js';
-import { BigIntStats, type Stats } from '../stats.js';
-import { Dirent } from './dir.js';
-export declare class FileHandle implements BufferToUint8Array<Node.promises.FileHandle> {
+import { BigIntStats, type BigIntStatsFs, type Stats, type StatsFs } from '../stats.js';
+import { Dirent, type Dir } from './dir.js';
+import type { PathLike } from './shared.js';
+export * as constants from './constants.js';
+import type { ReadableStream } from 'node:stream/web';
+import type { Interface as ReadlineInterface } from 'readline';
+export declare class FileHandle implements promises.FileHandle {
     /**
      * Gets the file descriptor for this file handle.
      */
@@ -17,6 +25,8 @@ export declare class FileHandle implements BufferToUint8Array<Node.promises.File
      * Gets the file descriptor for this file handle.
      */
     fd: number);
+    private get file();
+    private get path();
     /**
      * Asynchronous fchown(2) - Change ownership of a file.
      */
@@ -55,11 +65,7 @@ export declare class FileHandle implements BufferToUint8Array<Node.promises.File
      * If `mode` is a string, it is parsed as an octal integer.
      * If `flag` is not supplied, the default of `'a'` is used.
      */
-    appendFile(data: string | Uint8Array, _options?: {
-        encoding?: BufferEncoding;
-        mode?: Node.Mode;
-        flag?: Node.OpenMode;
-    } | BufferEncoding): Promise<void>;
+    appendFile(data: string | Uint8Array, _options?: (Node.ObjectEncodingOptions & FlagAndOpenMode) | BufferEncoding): Promise<void>;
     /**
      * Asynchronously reads data from the file.
      * The `FileHandle` must have been opened for reading.
@@ -68,10 +74,7 @@ export declare class FileHandle implements BufferToUint8Array<Node.promises.File
      * @param length The number of bytes to read.
      * @param position The offset from the beginning of the file from which data should be read. If `null`, data will be read from the current position.
      */
-    read<TBuffer extends Uint8Array>(buffer: TBuffer, offset?: number, length?: number, position?: number): Promise<{
-        bytesRead: number;
-        buffer: TBuffer;
-    }>;
+    read<TBuffer extends NodeJS.ArrayBufferView>(buffer: TBuffer, offset?: number, length?: number, position?: number): Promise<FileReadResult<TBuffer>>;
     /**
      * Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically.
      * The `FileHandle` must have been opened for reading.
@@ -80,11 +83,22 @@ export declare class FileHandle implements BufferToUint8Array<Node.promises.File
      */
     readFile(_options?: {
         flag?: Node.OpenMode;
-    }): Promise<Uint8Array>;
-    readFile(_options: {
-        encoding: BufferEncoding;
-        flag?: Node.OpenMode;
-    } | BufferEncoding): Promise<string>;
+    }): Promise<Buffer>;
+    readFile(_options: (Node.ObjectEncodingOptions & FlagAndOpenMode) | BufferEncoding): Promise<string>;
+    /**
+     * 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.
+     *
+     * 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
+     */
+    readableWebStream(options?: promises.ReadableWebStreamOptions): ReadableStream;
+    readLines(options?: promises.CreateReadStreamOptions): ReadlineInterface;
+    [Symbol.asyncDispose](): Promise<void>;
     /**
      * Asynchronous fstat(2) - Get file status.
      */
@@ -104,9 +118,9 @@ export declare class FileHandle implements BufferToUint8Array<Node.promises.File
      * @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.
      */
-    write(buffer: Uint8Array, offset?: number, length?: number, position?: number): Promise<{
+    write<TBuffer extends Uint8Array>(buffer: TBuffer, offset?: number, length?: number, position?: number): Promise<{
         bytesWritten: number;
-        buffer: Uint8Array;
+        buffer: TBuffer;
     }>;
     /**
      * Asynchronously writes `string` to the file.
@@ -135,16 +149,20 @@ export declare class FileHandle implements BufferToUint8Array<Node.promises.File
     writeFile(data: string | Uint8Array, _options?: Node.WriteFileOptions): Promise<void>;
     /**
      * See `fs.writev` promisified version.
+     * @todo Implement
      */
-    writev(buffers: ReadonlyArray<Uint8Array>, position?: number): Promise<Node.WriteVResult>;
+    writev(buffers: NodeJS.ArrayBufferView[], position?: number): Promise<Node.WriteVResult>;
     /**
      * See `fs.readv` promisified version.
+     * @todo Implement
      */
-    readv(buffers: ReadonlyArray<Uint8Array>, position?: number): Promise<Node.ReadVResult>;
+    readv(buffers: readonly NodeJS.ArrayBufferView[], position?: number): Promise<Node.ReadVResult>;
     /**
      * Asynchronous close(2) - close a `FileHandle`.
      */
     close(): Promise<void>;
+    createReadStream(options?: CreateReadStreamOptions): Node.ReadStream;
+    createWriteStream(options?: CreateWriteStreamOptions): Node.WriteStream;
 }
 /**
  * Renames a file
@@ -213,11 +231,10 @@ export declare function lopen(path: PathLike, flag: string, mode?: Node.Mode): P
  */
 export declare function readFile(filename: PathLike, options?: {
     flag?: Node.OpenMode;
-}): Promise<Uint8Array>;
-export declare function readFile(filename: PathLike, options: {
-    encoding?: BufferEncoding;
+}): Promise<Buffer>;
+export declare function readFile(filename: PathLike, options: (Node.EncodingOption & {
     flag?: Node.OpenMode;
-} | BufferEncoding): Promise<string>;
+}) | BufferEncoding): Promise<string>;
 /**
  * Synchronously writes data to a file, replacing the file if it already exists.
  *
@@ -240,64 +257,10 @@ export declare function writeFile(filename: PathLike, data: FileContents, _optio
  * @option options mode Defaults to `0644`.
  * @option options flag Defaults to `'a'`.
  */
-export declare function appendFile(filename: PathLike, data: FileContents, _options?: BufferEncoding | (Node.BaseEncodingOptions & {
+export declare function appendFile(filename: PathLike, data: FileContents, _options?: BufferEncoding | (Node.EncodingOption & {
     mode?: Node.Mode;
     flag?: Node.OpenMode;
 })): Promise<void>;
-/**
- * Write buffer to the file specified by `fd`.
- * Note that it is unsafe to use fs.write multiple times on the same file without waiting for it to return.
- * @param handle
- * @param data Uint8Array containing the data to write to the file.
- * @param offset Offset in the buffer to start reading data from.
- * @param length The amount of bytes to write to the file.
- * @param position Offset from the beginning of the file where this data should be written. If position is null, the data will be written at the current position.
- */
-export declare function write(handle: FileHandle, data: Uint8Array, offset: number, length: number, position?: number): Promise<{
-    bytesWritten: number;
-    buffer: Uint8Array;
-}>;
-export declare function write(handle: FileHandle, data: string, position?: number, encoding?: BufferEncoding): Promise<{
-    bytesWritten: number;
-    buffer: string;
-}>;
-/**
- * Read data from the file specified by `fd`.
- * @param handle
- * @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.
- */
-export declare function read(handle: FileHandle, buffer: Uint8Array, offset: number, length: number, position?: number): Promise<{
-    bytesRead: number;
-    buffer: Uint8Array;
-}>;
-/**
- * `fchown`.
- * @param handle
- * @param uid
- * @param gid
- */
-export declare function fchown(handle: FileHandle, uid: number, gid: number): Promise<void>;
-/**
- * `fchmod`.
- * @param handle
- * @param mode
- */
-export declare function fchmod(handle: FileHandle, mode: Node.Mode): Promise<void>;
-/**
- * Change the file timestamps of a file referenced by the supplied file
- * descriptor.
- * @param handle
- * @param atime
- * @param mtime
- */
-export declare function futimes(handle: FileHandle, atime: string | number | Date, mtime: string | number | Date): Promise<void>;
 /**
  * `rmdir`.
  * @param path
@@ -318,13 +281,13 @@ export declare function mkdir(path: PathLike, mode: Node.MakeDirectoryOptions &
  * `readdir`. Reads the contents of a directory.
  * @param path
  */
-export declare function readdir(path: PathLike, options?: (Node.BaseEncodingOptions & {
+export declare function readdir(path: PathLike, options?: (Node.EncodingOption & {
     withFileTypes?: false;
 }) | BufferEncoding): Promise<string[]>;
 export declare function readdir(path: PathLike, options: Node.BufferEncodingOption & {
     withFileTypes?: false;
-}): Promise<Uint8Array[]>;
-export declare function readdir(path: PathLike, options: Node.BaseEncodingOptions & {
+}): Promise<Buffer[]>;
+export declare function readdir(path: PathLike, options: Node.EncodingOption & {
     withFileTypes: true;
 }): Promise<Dirent[]>;
 /**
@@ -344,8 +307,8 @@ export declare function symlink(target: PathLike, path: PathLike, type?: Node.sy
  * readlink.
  * @param path
  */
-export declare function readlink(path: PathLike, options: Node.BufferEncodingOption): Promise<Uint8Array>;
-export declare function readlink(path: PathLike, options?: Node.BaseEncodingOptions | BufferEncoding): Promise<string>;
+export declare function readlink(path: PathLike, options: Node.BufferEncodingOption): Promise<Buffer>;
+export declare function readlink(path: PathLike, options?: Node.EncodingOption | BufferEncoding): Promise<string>;
 /**
  * `chown`.
  * @param path
@@ -393,37 +356,47 @@ export declare function lutimes(path: PathLike, atime: number | Date, mtime: num
  *
  * Note: This *Can not* use doOp since doOp depends on it
  */
-export declare function realpath(path: PathLike, options: Node.BufferEncodingOption): Promise<Uint8Array>;
-export declare function realpath(path: PathLike, options?: Node.BaseEncodingOptions | BufferEncoding): Promise<string>;
-export declare function watchFile(filename: PathLike, listener: (curr: Stats, prev: Stats) => void): Promise<void>;
-export declare function watchFile(filename: PathLike, options: {
-    persistent?: boolean;
-    interval?: number;
-}, listener: (curr: Stats, prev: Stats) => void): Promise<void>;
-export declare function unwatchFile(filename: PathLike, listener?: (curr: Stats, prev: Stats) => void): Promise<void>;
-export declare function watch(filename: PathLike, listener?: (event: string, filename: PathLike) => any): Promise<Node.FSWatcher>;
-export declare function watch(filename: PathLike, options: {
-    persistent?: boolean;
-}, listener?: (event: string, filename: string) => any): Promise<Node.FSWatcher>;
+export declare function realpath(path: PathLike, options: Node.BufferEncodingOption): Promise<Buffer>;
+export declare function realpath(path: PathLike, options?: Node.EncodingOption | BufferEncoding): Promise<string>;
+/**
+ * @todo Implement
+ */
+export declare function watch(filename: PathLike, options: (Node.WatchOptions & {
+    encoding: 'buffer';
+}) | 'buffer'): AsyncIterable<FileChangeInfo<Buffer>>;
+export declare function watch(filename: PathLike, options?: Node.WatchOptions | BufferEncoding): AsyncIterable<FileChangeInfo<string>>;
 /**
  * `access`.
  * @param path
  * @param mode
  */
 export declare function access(path: PathLike, mode?: number): Promise<void>;
-export declare function createReadStream(path: PathLike, options?: {
-    flags?: string;
-    encoding?: string;
-    fd?: number;
-    mode?: number;
-    autoClose?: boolean;
-}): Promise<Node.ReadStream>;
-export declare function createWriteStream(path: PathLike, options?: {
-    flags?: string;
-    encoding?: string;
-    fd?: number;
-    mode?: number;
-}): Promise<Node.WriteStream>;
-export declare function rm(path: PathLike): Promise<void>;
-export declare function mkdtemp(path: PathLike): Promise<void>;
-export declare function copyFile(path: PathLike): Promise<void>;
+/**
+ * @todo Implement
+ */
+export declare function rm(path: PathLike, options?: Node.RmOptions): Promise<void>;
+/**
+ * @todo Implement
+ */
+export declare function mkdtemp(prefix: string, options?: Node.EncodingOption): Promise<string>;
+export declare function mkdtemp(prefix: string, options?: Node.BufferEncodingOption): Promise<Buffer>;
+/**
+ * @todo Implement
+ */
+export declare function copyFile(src: PathLike, dest: PathLike, mode?: number): Promise<void>;
+/**
+ * @todo Implement
+ */
+export declare function opendir(path: PathLike, options?: Node.OpenDirOptions): Promise<Dir>;
+export declare function cp(source: PathLike, destination: PathLike, opts?: Node.CopyOptions): Promise<void>;
+/**
+ * @since v18.15.0
+ * @return Fulfills with an {fs.StatFs} for the file system.
+ */
+export declare function statfs(path: PathLike, opts?: Node.StatFsOptions & {
+    bigint?: false;
+}): Promise<StatsFs>;
+export declare function statfs(path: PathLike, opts: Node.StatFsOptions & {
+    bigint: true;
+}): Promise<BigIntStatsFs>;
+export declare function statfs(path: PathLike, opts?: Node.StatFsOptions): Promise<StatsFs | BigIntStatsFs>;