@zenfs/core 0.0.12 → 0.1.0

package/dist/emulation/dir.js

@@ -0,0 +1,104 @@
+import { readdir } from './promises.js';
+import { ApiError, ErrorCode } from '../ApiError.js';
+import { readdirSync } from './sync.js';
+export class Dirent {
+    constructor(name, stats) {
+        this.name = name;
+        this.stats = stats;
+    }
+    isFile() {
+        return this.stats.isFile();
+    }
+    isDirectory() {
+        return this.stats.isDirectory();
+    }
+    isBlockDevice() {
+        return this.stats.isBlockDevice();
+    }
+    isCharacterDevice() {
+        return this.stats.isCharacterDevice();
+    }
+    isSymbolicLink() {
+        return this.stats.isSymbolicLink();
+    }
+    isFIFO() {
+        return this.stats.isFIFO();
+    }
+    isSocket() {
+        return this.stats.isSocket();
+    }
+}
+/**
+ * A class representing a directory stream.
+ */
+export class Dir {
+    checkClosed() {
+        if (this.closed) {
+            throw new ApiError(ErrorCode.EBADF, 'Can not use closed Dir');
+        }
+    }
+    constructor(path) {
+        this.path = path;
+        this.closed = false;
+    }
+    close(cb) {
+        this.closed = true;
+        if (!cb) {
+            return Promise.resolve();
+        }
+        cb();
+    }
+    /**
+     * Synchronously close the directory's underlying resource handle.
+     * Subsequent reads will result in errors.
+     */
+    closeSync() {
+        this.closed = true;
+    }
+    async _read() {
+        if (!this._entries) {
+            this._entries = await readdir(this.path, { withFileTypes: true });
+        }
+        if (this._entries.length == 0) {
+            return null;
+        }
+        return this._entries.shift();
+    }
+    read(cb) {
+        if (!cb) {
+            return this._read();
+        }
+        this._read().then(value => cb(null, value));
+    }
+    /**
+     * Synchronously read the next directory entry via `readdir(3)` as a `Dirent`.
+     * 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.
+     */
+    readSync() {
+        if (!this._entries) {
+            this._entries = readdirSync(this.path, { withFileTypes: true });
+        }
+        if (this._entries.length == 0) {
+            return null;
+        }
+        return this._entries.shift();
+    }
+    /**
+     * Asynchronously iterates over the directory via `readdir(3)` until all entries have been read.
+     */
+    [Symbol.asyncIterator]() {
+        const _this = this;
+        return {
+            [Symbol.asyncIterator]: this[Symbol.asyncIterator],
+            async next() {
+                const value = await _this._read();
+                if (value != null) {
+                    return { done: false, value };
+                }
+                await _this.close();
+                return { done: true, value: undefined };
+            },
+        };
+    }
+}

package/dist/emulation/fs.d.ts

@@ -1,7 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 import * as fs_mock from './index.js';
 import type * as fs_node from 'node:fs';
-type ZenFSModule = typeof fs_node & typeof fs_mock;
-declare const fs: ZenFSModule;
+declare const fs: typeof fs_node & typeof fs_mock;
 export * from './index.js';
 export default fs;

package/dist/emulation/fs.js

@@ -1,5 +1,4 @@
 import * as fs_mock from './index.js';
-// @ts-expect-error 2322
 const fs = fs_mock;
 export * from './index.js';
 export default fs;

package/dist/emulation/index.d.ts

@@ -2,4 +2,7 @@ export * from './callbacks.js';
 export * from './sync.js';
 export * as promises from './promises.js';
 export * as constants from './constants.js';
+export * from './streams.js';
+export * from './dir.js';
 export { initialize, getMount, getMounts, mount, umount, _toUnixTimestamp } from './shared.js';
+export { Stats, BigIntStats } from '../stats.js';

package/dist/emulation/index.js

@@ -2,4 +2,7 @@ export * from './callbacks.js';
 export * from './sync.js';
 export * as promises from './promises.js';
 export * as constants from './constants.js';
+export * from './streams.js';
+export * from './dir.js';
 export { initialize, getMount, getMounts, mount, umount, _toUnixTimestamp } from './shared.js';
+export { Stats, BigIntStats } from '../stats.js';

package/dist/emulation/promises.d.ts

@@ -1,27 +1,32 @@
 /// <reference types="node" resolution-mode="require"/>
 /// <reference types="node" resolution-mode="require"/>
-import type { ReadStream, WriteStream, FSWatcher, symlink as _symlink } from 'node:fs';
+import type { ReadStream, WriteStream, FSWatcher, symlink as _symlink, BaseEncodingOptions, BufferEncodingOption, BigIntOptions } from 'node:fs';
 import * as constants from './constants.js';
 export { constants };
+import { PathLike } from './shared.js';
 import { FileContents } from '../filesystem.js';
-import { Stats } from '../stats.js';
+import { BigIntStats, Stats } from '../stats.js';
+import { Dirent } from './dir.js';
 /**
  * Renames a file
  * @param oldPath
  * @param newPath
  */
-export declare function rename(oldPath: string, newPath: string): Promise<void>;
+export declare function rename(oldPath: PathLike, newPath: PathLike): Promise<void>;
 /**
  * Test whether or not the given path exists by checking with the file system.
  * @param path
  */
-export declare function exists(path: string): Promise<boolean>;
+export declare function exists(path: PathLike): Promise<boolean>;
 /**
  * `stat`.
  * @param path
  * @returns Stats
  */
-export declare function stat(path: string): Promise<Stats>;
+export declare function stat(path: PathLike, options: BigIntOptions): Promise<BigIntStats>;
+export declare function stat(path: PathLike, options?: {
+    bigint?: false;
+}): Promise<Stats>;
 /**
  * `lstat`.
  * `lstat()` is identical to `stat()`, except that if path is a symbolic link,
@@ -29,18 +34,23 @@ export declare function stat(path: string): Promise<Stats>;
  * @param path
  * @return [ZenFS.node.fs.Stats]
  */
-export declare function lstat(path: string): Promise<Stats>;
+export declare function lstat(path: PathLike, options?: {
+    bigint?: false;
+}): Promise<Stats>;
+export declare function lstat(path: PathLike, options: {
+    bigint: true;
+}): Promise<BigIntStats>;
 /**
  * `truncate`.
  * @param path
  * @param len
  */
-export declare function truncate(path: string, len?: number): Promise<void>;
+export declare function truncate(path: PathLike, len?: number): Promise<void>;
 /**
  * `unlink`.
  * @param path
  */
-export declare function unlink(path: string): Promise<void>;
+export declare function unlink(path: PathLike): Promise<void>;
 /**
  * file open.
  * @see http://www.manpagez.com/man/2/open/
@@ -48,23 +58,23 @@ export declare function unlink(path: string): Promise<void>;
  * @param flags
  * @param mode defaults to `0644`
  */
-export declare function open(path: string, flag: string, mode?: number | string): Promise<number>;
+export declare function open(path: PathLike, flag: string, mode?: number | string): Promise<number>;
 /**
  * Synchronously reads the entire contents of a file.
  * @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'`.
- * @return [String | ZenFS.node.Uint8Array]
+ * options.encoding The string encoding for the file contents. Defaults to `null`.
+ * options.flag Defaults to `'r'`.
+ * @return Uint8Array
  */
-export declare function readFile(filename: string, options?: {
+export declare function readFile(filename: PathLike, options?: {
     flag?: string;
 }): Promise<Uint8Array>;
-export declare function readFile(filename: string, options: {
+export declare function readFile(filename: PathLike, options: {
     encoding: string;
     flag?: string;
 }): Promise<string>;
-export declare function readFile(filename: string, encoding: string): Promise<string>;
+export declare function readFile(filename: PathLike, encoding: string): Promise<string>;
 /**
  * Synchronously writes data to a file, replacing the file if it already
  * exists.
@@ -77,13 +87,13 @@ export declare function readFile(filename: string, encoding: string): Promise<st
  * @option options [Number] mode Defaults to `0644`.
  * @option options [String] flag Defaults to `'w'`.
  */
-export declare function writeFile(filename: string, data: FileContents, options?: {
+export declare function writeFile(filename: PathLike, data: FileContents, options?: {
     encoding?: string;
     mode?: number | string;
     flag?: string;
 }): Promise<void>;
-export declare function writeFile(filename: string, data: FileContents, encoding?: string): Promise<void>;
-export declare function writeFile(filename: string, data: FileContents, options?: {
+export declare function writeFile(filename: PathLike, data: FileContents, encoding?: string): Promise<void>;
+export declare function writeFile(filename: PathLike, data: FileContents, options?: {
     encoding?: string;
     mode?: number | string;
     flag?: string;
@@ -104,12 +114,12 @@ export declare function writeFile(filename: string, data: FileContents, options?
  * @option options [Number] mode Defaults to `0644`.
  * @option options [String] flag Defaults to `'a'`.
  */
-export declare function appendFile(filename: string, data: FileContents, options?: {
+export declare function appendFile(filename: PathLike, data: FileContents, options?: {
     encoding?: string;
     mode?: number | string;
     flag?: string;
 }): Promise<void>;
-export declare function appendFile(filename: string, data: FileContents, encoding?: string): Promise<void>;
+export declare function appendFile(filename: PathLike, data: FileContents, encoding?: string): Promise<void>;
 /**
  * `fstat`.
  * `fstat()` is identical to `stat()`, except that the file to be stat-ed is
@@ -117,7 +127,12 @@ export declare function appendFile(filename: string, data: FileContents, encodin
  * @param fd
  * @return [ZenFS.node.fs.Stats]
  */
-export declare function fstat(fd: number): Promise<Stats>;
+export declare function fstat(fd: number, options?: {
+    bigint?: false;
+}): Promise<Stats>;
+export declare function fstat(fd: number, options: {
+    bigint: true;
+}): Promise<BigIntStats>;
 /**
  * close.
  * @param fd
@@ -195,97 +210,100 @@ export declare function futimes(fd: number, atime: number | Date, mtime: number
  * `rmdir`.
  * @param path
  */
-export declare function rmdir(path: string): Promise<void>;
+export declare function rmdir(path: PathLike): Promise<void>;
 /**
  * `mkdir`.
  * @param path
  * @param mode defaults to `0777`
  */
-export declare function mkdir(path: string, mode?: number | string): Promise<void>;
+export declare function mkdir(path: PathLike, mode?: number | string): Promise<void>;
 /**
  * `readdir`. Reads the contents of a directory.
  * @param path
- * @return [String[]]
  */
-export declare function readdir(path: string): Promise<string[]>;
+export declare function readdir(path: PathLike, options: {
+    withFileTypes?: false;
+}): Promise<string[]>;
+export declare function readdir(path: PathLike, options: {
+    withFileTypes: true;
+}): Promise<Dirent[]>;
 /**
  * `link`.
  * @param srcpath
  * @param dstpath
  */
-export declare function link(srcpath: string, dstpath: string): Promise<void>;
+export declare function link(srcpath: PathLike, dstpath: PathLike): Promise<void>;
 /**
  * `symlink`.
  * @param srcpath
  * @param dstpath
  * @param type can be either `'dir'` or `'file'` (default is `'file'`)
  */
-export declare function symlink(srcpath: string, dstpath: string, type?: _symlink.Type): Promise<void>;
+export declare function symlink(srcpath: PathLike, dstpath: PathLike, type?: _symlink.Type): Promise<void>;
 /**
  * readlink.
  * @param path
- * @return [String]
  */
-export declare function readlink(path: string): Promise<string>;
+export declare function readlink(path: PathLike, options?: BaseEncodingOptions | BufferEncoding): Promise<string>;
+export declare function readlink(path: PathLike, options: BufferEncodingOption): Promise<Uint8Array>;
+export declare function readlink(path: PathLike, options?: BaseEncodingOptions | string): Promise<string | Uint8Array>;
 /**
  * `chown`.
  * @param path
  * @param uid
  * @param gid
  */
-export declare function chown(path: string, uid: number, gid: number): Promise<void>;
+export declare function chown(path: PathLike, uid: number, gid: number): Promise<void>;
 /**
  * `lchown`.
  * @param path
  * @param uid
  * @param gid
  */
-export declare function lchown(path: string, uid: number, gid: number): Promise<void>;
+export declare function lchown(path: PathLike, uid: number, gid: number): Promise<void>;
 /**
  * `chmod`.
  * @param path
  * @param mode
  */
-export declare function chmod(path: string, mode: string | number): Promise<void>;
+export declare function chmod(path: PathLike, mode: string | number): Promise<void>;
 /**
  * `lchmod`.
  * @param path
  * @param mode
  */
-export declare function lchmod(path: string, mode: number | string): Promise<void>;
+export declare function lchmod(path: PathLike, mode: number | string): Promise<void>;
 /**
  * Change file timestamps of the file referenced by the supplied path.
  * @param path
  * @param atime
  * @param mtime
  */
-export declare function utimes(path: string, atime: number | Date, mtime: number | Date): Promise<void>;
+export declare function utimes(path: PathLike, atime: number | Date, mtime: 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: string, atime: number | Date, mtime: number | Date): Promise<void>;
+export declare function lutimes(path: PathLike, atime: number | Date, mtime: number | Date): Promise<void>;
 /**
  * `realpath`.
  * @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.
- * @return [String]
+ * @param options
+ * @return resolved path
+ *
+ * Note: This *Can not* use doOp since doOp depends on it
  */
-export declare function realpath(path: string, cache?: {
-    [path: string]: string;
-}): Promise<string>;
-export declare function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): Promise<void>;
-export declare function watchFile(filename: string, options: {
+export declare function realpath(path: PathLike, options?: BaseEncodingOptions): 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: string, listener?: (curr: Stats, prev: Stats) => void): Promise<void>;
-export declare function watch(filename: string, listener?: (event: string, filename: string) => any): Promise<FSWatcher>;
-export declare function watch(filename: string, options: {
+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<FSWatcher>;
+export declare function watch(filename: PathLike, options: {
     persistent?: boolean;
 }, listener?: (event: string, filename: string) => any): Promise<FSWatcher>;
 /**
@@ -293,17 +311,20 @@ export declare function watch(filename: string, options: {
  * @param path
  * @param mode
  */
-export declare function access(path: string, mode?: number): Promise<void>;
-export declare function createReadStream(path: string, options?: {
+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<ReadStream>;
-export declare function createWriteStream(path: string, options?: {
+export declare function createWriteStream(path: PathLike, options?: {
     flags?: string;
     encoding?: string;
     fd?: number;
     mode?: number;
 }): Promise<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>;