@zenfs/core 1.7.2 → 1.8.0

package/dist/stats.d.ts

@@ -1,6 +1,7 @@
 import type * as Node from 'node:fs';
 import type { V_Context } from './context.js';
 import * as c from './vfs/constants.js';
+import type { InodeFields, InodeLike } from './backends/store/inode.js';
 /**
  * Indicates the type of a file. Applied to 'mode'.
  */
@@ -91,8 +92,10 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
     gid: T;
     /**
      * Some file systems stash data on stats objects.
+     * @todo [BREAKING] Remove this
+     * @deprecated @hidden
      */
-    fileData?: Uint8Array;
+    fileData?: unknown;
     /**
      * Time of last access, since epoch
      */
@@ -122,10 +125,12 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
      * For directories/symlinks, this is normally the size of the struct that represents the item.
      */
     size: T;
+    data?: number;
+    flags?: number;
     /**
      * Creates a new stats instance from a stats-like object. Can be used to copy stats (note)
      */
-    constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino }?: Partial<StatsLike>);
+    constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino, ...rest }?: Partial<InodeLike>);
     isFile(): boolean;
     isDirectory(): boolean;
     isSymbolicLink(): boolean;
@@ -133,6 +138,7 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
     isBlockDevice(): boolean;
     isCharacterDevice(): boolean;
     isFIFO(): boolean;
+    toJSON(): StatsLike<T> & InodeFields;
     /**
      * Checks if a given user/group has access to this item
      * @param mode The requested access, combination of W_OK, R_OK, and X_OK
@@ -143,15 +149,15 @@ export declare abstract class StatsCommon<T extends number | bigint> implements
     /**
      * Change the mode of the file.
      * We use this helper function to prevent messing up the type of the file.
-     * @internal
-     * @deprecated This will be removed in the next minor release since it is internal
+     * @internal @deprecated
+     * @todo [BREAKING] Remove
      */
     chmod(mode: number): void;
     /**
      * Change the owner user/group of the file.
      * This function makes sure it is a valid UID/GID (that is, a 32 unsigned int)
-     * @internal
-     * @deprecated This will be removed in the next minor release since it is internal
+     * @internal @deprecated
+     * @todo [BREAKING] Remove
      */
     chown(uid: number, gid: number): void;
     get atimeNs(): bigint;

package/dist/stats.js

@@ -1,5 +1,7 @@
 import { credentials } from './credentials.js';
 import * as c from './vfs/constants.js';
+import { pick } from 'utilium';
+import { _inode_fields } from './backends/store/inode.js';
 const n1000 = BigInt(1000);
 /**
  * Provides information about a particular entry in the file system.
@@ -39,7 +41,7 @@ export class StatsCommon {
     /**
      * Creates a new stats instance from a stats-like object. Can be used to copy stats (note)
      */
-    constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino } = {}) {
+    constructor({ atimeMs, mtimeMs, ctimeMs, birthtimeMs, uid, gid, size, mode, ino, ...rest } = {}) {
         /**
          * ID of device containing file
          */
@@ -81,6 +83,7 @@ export class StatsCommon {
         if ((this.mode & c.S_IFMT) == 0) {
             this.mode = (this.mode | this._convert(c.S_IFREG));
         }
+        Object.assign(this, rest);
     }
     isFile() {
         return (this.mode & c.S_IFMT) === c.S_IFREG;
@@ -103,6 +106,9 @@ export class StatsCommon {
     isFIFO() {
         return (this.mode & c.S_IFMT) === c.S_IFIFO;
     }
+    toJSON() {
+        return pick(this, _inode_fields);
+    }
     /**
      * Checks if a given user/group has access to this item
      * @param mode The requested access, combination of W_OK, R_OK, and X_OK
@@ -142,11 +148,12 @@ export class StatsCommon {
         // Perform the access check
         return (perm & mode) === mode;
     }
+    /* node:coverage disable */
     /**
      * Change the mode of the file.
      * We use this helper function to prevent messing up the type of the file.
-     * @internal
-     * @deprecated This will be removed in the next minor release since it is internal
+     * @internal @deprecated
+     * @todo [BREAKING] Remove
      */
     chmod(mode) {
         this.mode = this._convert((this.mode & c.S_IFMT) | mode);
@@ -154,8 +161,8 @@ export class StatsCommon {
     /**
      * Change the owner user/group of the file.
      * This function makes sure it is a valid UID/GID (that is, a 32 unsigned int)
-     * @internal
-     * @deprecated This will be removed in the next minor release since it is internal
+     * @internal @deprecated
+     * @todo [BREAKING] Remove
      */
     chown(uid, gid) {
         uid = Number(uid);
@@ -167,6 +174,7 @@ export class StatsCommon {
             this.gid = this._convert(gid);
         }
     }
+    /* node:coverage enable */
     get atimeNs() {
         return BigInt(this.atimeMs) * n1000;
     }
@@ -184,7 +192,7 @@ export class StatsCommon {
  * @hidden @internal
  */
 export function _chown(stats, uid, gid) {
-    if (!isNaN(uid) && 0 <= uid && uid < 2 ** 32) {
+    if (!isNaN(uid) && 0 <= uid && uid < c.size_max) {
         stats.uid = uid;
     }
     if (!isNaN(gid) && 0 <= gid && gid < 2 ** 32) {

package/dist/utils.d.ts

@@ -32,15 +32,16 @@ export { /** @deprecated @hidden */ decodeUTF8 as decode };
  * Decodes a directory listing
  * @hidden
  */
-export declare function decodeDirListing(data: Uint8Array): Record<string, bigint>;
+export declare function decodeDirListing(data: Uint8Array): Record<string, number>;
 /**
  * Encodes a directory listing
  * @hidden
  */
-export declare function encodeDirListing(data: Record<string, bigint>): Uint8Array;
+export declare function encodeDirListing(data: Record<string, number>): Uint8Array;
 export type Callback<Args extends unknown[] = [], NoError = undefined | void> = (e: ErrnoError | NoError, ...args: OptionalTuple<Args>) => unknown;
 /**
  * Normalizes a mode
+ * @param def default
  * @internal
  */
 export declare function normalizeMode(mode: unknown, def?: number): number;
@@ -48,7 +49,7 @@ export declare function normalizeMode(mode: unknown, def?: number): number;
  * Normalizes a time
  * @internal
  */
-export declare function normalizeTime(time: string | number | Date): Date;
+export declare function normalizeTime(time: string | number | Date): number;
 /**
  * Normalizes a path
  * @internal
@@ -75,3 +76,16 @@ export type Concrete<T extends ClassLike> = Pick<T, keyof T> & (new (...args: an
  * @internal
  */
 export declare function randomBigInt(): bigint;
+/**
+ * Prevents infinite loops
+ * @internal
+ */
+export declare function canary(path?: string, syscall?: string): () => void;
+/**
+ * A wrapper for throwing things.
+ * Used in expressions.
+ * @todo Remove once `throw` is allowed in expressions
+ * @see https://github.com/tc39/proposal-throw-expressions
+ * @internal @hidden
+ */
+export declare function _throw(e: unknown): never;

package/dist/utils.js

@@ -34,7 +34,9 @@ export function encodeUTF8(input) {
     }
     return encoder.encode(input);
 }
+/* node:coverage disable */
 export { /** @deprecated @hidden */ encodeUTF8 as encode };
+/* node:coverage enable */
 const decoder = new TextDecoder();
 /**
  * Decodes a string from a buffer
@@ -46,38 +48,39 @@ export function decodeUTF8(input) {
     }
     return decoder.decode(input);
 }
+/* node:coverage disable */
 export { /** @deprecated @hidden */ decodeUTF8 as decode };
+/* node:coverage enable */
 /**
  * Decodes a directory listing
  * @hidden
  */
 export function decodeDirListing(data) {
-    return JSON.parse(decodeUTF8(data), (k, v) => (k == '' ? v : BigInt(v)));
+    return JSON.parse(decodeUTF8(data), (k, v) => (k == '' ? v : typeof v == 'string' ? BigInt(v).toString(16).slice(0, Math.min(v.length, 8)) : v));
 }
 /**
  * Encodes a directory listing
  * @hidden
  */
 export function encodeDirListing(data) {
-    return encodeUTF8(JSON.stringify(data, (k, v) => (k == '' ? v : v.toString())));
+    return encodeUTF8(JSON.stringify(data));
 }
 /**
  * Normalizes a mode
+ * @param def default
  * @internal
  */
 export function normalizeMode(mode, def) {
-    if (typeof mode == 'number') {
+    if (typeof mode == 'number')
         return mode;
-    }
     if (typeof mode == 'string') {
         const parsed = parseInt(mode, 8);
         if (!isNaN(parsed)) {
             return parsed;
         }
     }
-    if (typeof def == 'number') {
+    if (typeof def == 'number')
         return def;
-    }
     throw new ErrnoError(Errno.EINVAL, 'Invalid mode: ' + (mode === null || mode === void 0 ? void 0 : mode.toString()));
 }
 /**
@@ -85,11 +88,10 @@ export function normalizeMode(mode, def) {
  * @internal
  */
 export function normalizeTime(time) {
-    if (time instanceof Date) {
-        return time;
-    }
+    if (time instanceof Date)
+        return time.getTime();
     try {
-        return new Date(time);
+        return Number(time);
     }
     catch {
         throw new ErrnoError(Errno.EINVAL, 'Invalid time.');
@@ -138,3 +140,23 @@ export function normalizeOptions(options, encoding = 'utf8', flag, mode = 0) {
 export function randomBigInt() {
     return BigInt('0x' + randomHex(8));
 }
+/**
+ * Prevents infinite loops
+ * @internal
+ */
+export function canary(path, syscall) {
+    const timeout = setTimeout(() => {
+        throw ErrnoError.With('EDEADLK', path, syscall);
+    }, 5000);
+    return () => clearTimeout(timeout);
+}
+/**
+ * A wrapper for throwing things.
+ * Used in expressions.
+ * @todo Remove once `throw` is allowed in expressions
+ * @see https://github.com/tc39/proposal-throw-expressions
+ * @internal @hidden
+ */
+export function _throw(e) {
+    throw e;
+}

package/dist/vfs/constants.d.ts

@@ -111,7 +111,7 @@ export declare const S_IXOTH = 1;
  */
 export declare const UV_FS_O_FILEMAP = 0;
 /**
- * Max 32-bit integer
+ * Max 32-bit unsigned integer
  * @hidden
  */
-export declare const size_max: number;
+export declare const size_max = 4294967295;

package/dist/vfs/constants.js

@@ -123,7 +123,7 @@ export const S_IXOTH = 1;
  */
 export const UV_FS_O_FILEMAP = 0;
 /**
- * Max 32-bit integer
+ * Max 32-bit unsigned integer
  * @hidden
  */
-export const size_max = 2 ** 32 - 1;
+export const size_max = 0xffffffff; // 2^32 - 1

package/dist/vfs/dir.js

@@ -66,7 +66,9 @@ export class Dir {
     async _read() {
         var _a, _b;
         this.checkClosed();
-        (_a = this._entries) !== null && _a !== void 0 ? _a : (this._entries = await readdir.call(this.context, this.path, { withFileTypes: true }));
+        (_a = this._entries) !== null && _a !== void 0 ? _a : (this._entries = await readdir.call(this.context, this.path, {
+            withFileTypes: true,
+        }));
         if (!this._entries.length)
             return null;
         return (_b = this._entries.shift()) !== null && _b !== void 0 ? _b : null;

package/dist/vfs/index.js

@@ -4,6 +4,7 @@ export * as constants from './constants.js';
 export * from './dir.js';
 export * as promises from './promises.js';
 export { chroot, mount, mountObject, 
+/* node:coverage disable */
 /**
  * The map of mount points.
  * Using `fs.mounts` instead of the `mounts` export is a security issue and not recommended.
@@ -11,6 +12,8 @@ export { chroot, mount, mountObject,
  * @todo [BREAKING] remove `fs.mounts` for security.
  * @deprecated Use the `mounts` export that isn't an `fs` property!
  */
-mounts, umount, } from './shared.js';
+mounts, 
+/* node:coverage enable */
+umount, } from './shared.js';
 export * from './streams.js';
 export * from './sync.js';

package/dist/vfs/promises.js

@@ -213,7 +213,10 @@ export class FileHandle {
         if (!('ReadableStream' in _gt)) {
             throw new ErrnoError(Errno.ENOSYS, 'ReadableStream is missing on globalThis');
         }
-        return new _gt.ReadableStream({ start, type: options.type });
+        return new _gt.ReadableStream({
+            start,
+            type: options.type,
+        });
     }
     /**
      * @todo Implement
@@ -478,11 +481,11 @@ async function applySetId(file, uid, gid) {
  * Opens a file. This helper handles the complexity of file flags.
  * @internal
  */
-async function _open(path, _flag, _mode = 0o644, resolveSymlinks) {
+async function _open(path, opt) {
     var _a;
     path = normalizePath(path);
-    const mode = normalizeMode(_mode, 0o644), flag = parseFlag(_flag);
-    path = resolveSymlinks ? await realpath.call(this, path) : path;
+    const mode = normalizeMode(opt.mode, 0o644), flag = parseFlag(opt.flag);
+    path = opt.preserveSymlinks ? path : await realpath.call(this, path);
     const { fs, path: resolved } = resolveMount(path, this);
     const stats = await fs.stat(resolved).catch(() => null);
     if (!stats) {
@@ -527,7 +530,7 @@ async function _open(path, _flag, _mode = 0o644, resolveSymlinks) {
  * @param mode Mode to use to open the file. Can be ignored if the filesystem doesn't support permissions.
  */
 export async function open(path, flag = 'r', mode = 0o644) {
-    return await _open.call(this, path, flag, mode, true);
+    return await _open.call(this, path, { flag, mode });
 }
 open;
 export async function readFile(path, _options) {
@@ -771,7 +774,7 @@ export async function symlink(target, path, type = 'file') {
         if (await exists.call(this, path)) {
             throw ErrnoError.With('EEXIST', path.toString(), 'symlink');
         }
-        const handle = __addDisposableResource(env_5, await _open.call(this, path, 'w+', 0o644, false), true);
+        const handle = __addDisposableResource(env_5, await _open.call(this, path, { flag: 'w+', mode: 0o644, preserveSymlinks: true }), true);
         await handle.writeFile(target.toString());
         await handle.file.chmod(constants.S_IFLNK);
     }
@@ -789,7 +792,7 @@ symlink;
 export async function readlink(path, options) {
     const env_6 = { stack: [], error: void 0, hasError: false };
     try {
-        const handle = __addDisposableResource(env_6, await _open.call(this, normalizePath(path), 'r', 0o644, false), true);
+        const handle = __addDisposableResource(env_6, await _open.call(this, normalizePath(path), { flag: 'r', mode: 0o644, preserveSymlinks: true }), true);
         const value = await handle.readFile();
         const encoding = typeof options == 'object' ? options === null || options === void 0 ? void 0 : options.encoding : options;
         // always defaults to utf-8 to avoid wrangler (cloudflare) worker "unknown encoding" exception
@@ -826,7 +829,12 @@ chown;
 export async function lchown(path, uid, gid) {
     const env_8 = { stack: [], error: void 0, hasError: false };
     try {
-        const handle = __addDisposableResource(env_8, await _open.call(this, path, 'r+', 0o644, false), true);
+        const handle = __addDisposableResource(env_8, await _open.call(this, path, {
+            flag: 'r+',
+            mode: 0o644,
+            preserveSymlinks: true,
+            allowDirectory: true,
+        }), true);
         await handle.chown(uid, gid);
     }
     catch (e_8) {
@@ -860,7 +868,12 @@ chmod;
 export async function lchmod(path, mode) {
     const env_10 = { stack: [], error: void 0, hasError: false };
     try {
-        const handle = __addDisposableResource(env_10, await _open.call(this, path, 'r+', 0o644, false), true);
+        const handle = __addDisposableResource(env_10, await _open.call(this, path, {
+            flag: 'r+',
+            mode: 0o644,
+            preserveSymlinks: true,
+            allowDirectory: true,
+        }), true);
         await handle.chmod(mode);
     }
     catch (e_10) {
@@ -900,7 +913,12 @@ utimes;
 export async function lutimes(path, atime, mtime) {
     const env_12 = { stack: [], error: void 0, hasError: false };
     try {
-        const handle = __addDisposableResource(env_12, await _open.call(this, path, 'r+', 0o644, false), true);
+        const handle = __addDisposableResource(env_12, await _open.call(this, path, {
+            flag: 'r+',
+            mode: 0o644,
+            preserveSymlinks: true,
+            allowDirectory: true,
+        }), true);
         await handle.utimes(new Date(atime), new Date(mtime));
     }
     catch (e_12) {
@@ -1006,7 +1024,9 @@ export async function rm(path, options) {
     switch (stats.mode & constants.S_IFMT) {
         case constants.S_IFDIR:
             if (options === null || options === void 0 ? void 0 : options.recursive) {
-                for (const entry of await readdir.call(this, path, { _isIndirect: true })) {
+                for (const entry of await readdir.call(this, path, {
+                    _isIndirect: true,
+                })) {
                     await rm.call(this, join(path, entry), { ...options, _isIndirect: true });
                 }
             }

package/dist/vfs/shared.js

@@ -113,6 +113,7 @@ export function fixError(e, paths) {
         e.path = fixPaths(e.path, paths);
     return e;
 }
+/* node:coverage disable */
 /**
  * @internal @deprecated
  */
@@ -124,6 +125,7 @@ export function mountObject(mounts) {
         mount(point, fs);
     }
 }
+/* node:coverage enable */
 /**
  * @internal @hidden
  */

package/dist/vfs/sync.js

@@ -134,7 +134,7 @@ lstatSync;
 export function truncateSync(path, len = 0) {
     const env_1 = { stack: [], error: void 0, hasError: false };
     try {
-        const file = __addDisposableResource(env_1, _openSync.call(this, path, 'r+'), false);
+        const file = __addDisposableResource(env_1, _openSync.call(this, path, { flag: 'r+' }), false);
         len || (len = 0);
         if (len < 0) {
             throw new ErrnoError(Errno.EINVAL);
@@ -176,11 +176,11 @@ function applySetId(file, uid, gid) {
     file.chownSync(parent.mode & constants.S_ISUID ? parent.uid : uid, // manually apply setuid/setgid
     parent.mode & constants.S_ISGID ? parent.gid : gid);
 }
-function _openSync(path, _flag, _mode, resolveSymlinks = true) {
+function _openSync(path, opt) {
     var _a;
     path = normalizePath(path);
-    const mode = normalizeMode(_mode, 0o644), flag = parseFlag(_flag);
-    path = resolveSymlinks ? realpathSync.call(this, path) : path;
+    const mode = normalizeMode(opt.mode, 0o644), flag = parseFlag(opt.flag);
+    path = opt.preserveSymlinks ? path : realpathSync.call(this, path);
     const { fs, path: resolved } = resolveMount(path, this);
     let stats;
     try {
@@ -203,6 +203,8 @@ function _openSync(path, _flag, _mode, resolveSymlinks = true) {
         }
         const { euid: uid, egid: gid } = (_a = this === null || this === void 0 ? void 0 : this.credentials) !== null && _a !== void 0 ? _a : credentials;
         const file = fs.createFileSync(resolved, flag, mode, { uid, gid });
+        if (!opt.allowDirectory && mode & constants.S_IFDIR)
+            throw ErrnoError.With('EISDIR', path, '_open');
         applySetId(file, uid, gid);
         return file;
     }
@@ -216,6 +218,8 @@ function _openSync(path, _flag, _mode, resolveSymlinks = true) {
     if (isTruncating(flag)) {
         file.truncateSync(0);
     }
+    if (!opt.allowDirectory && stats.mode & constants.S_IFDIR)
+        throw ErrnoError.With('EISDIR', path, '_open');
     return file;
 }
 /**
@@ -223,7 +227,7 @@ function _openSync(path, _flag, _mode, resolveSymlinks = true) {
  * @see http://www.manpagez.com/man/2/open/
  */
 export function openSync(path, flag, mode = constants.F_OK) {
-    return file2fd(_openSync.call(this, path, flag, mode, true));
+    return file2fd(_openSync.call(this, path, { flag, mode }));
 }
 openSync;
 /**
@@ -231,13 +235,13 @@ openSync;
  * @internal
  */
 export function lopenSync(path, flag, mode) {
-    return file2fd(_openSync.call(this, path, flag, mode, false));
+    return file2fd(_openSync.call(this, path, { flag, mode, preserveSymlinks: true }));
 }
-function _readFileSync(fname, flag, resolveSymlinks) {
+function _readFileSync(fname, flag, preserveSymlinks) {
     const env_2 = { stack: [], error: void 0, hasError: false };
     try {
         // Get file.
-        const file = __addDisposableResource(env_2, _openSync.call(this, fname, flag, 0o644, resolveSymlinks), false);
+        const file = __addDisposableResource(env_2, _openSync.call(this, fname, { flag, mode: 0o644, preserveSymlinks }), false);
         const stat = file.statSync();
         // Allocate buffer.
         const data = new Uint8Array(stat.size);
@@ -258,7 +262,7 @@ export function readFileSync(path, _options = {}) {
     if (!isReadable(flag)) {
         throw new ErrnoError(Errno.EINVAL, 'Flag passed to readFile must allow for reading.');
     }
-    const data = Buffer.from(_readFileSync.call(this, typeof path == 'number' ? fd2file(path).path : path.toString(), options.flag, true));
+    const data = Buffer.from(_readFileSync.call(this, typeof path == 'number' ? fd2file(path).path : path.toString(), options.flag, false));
     return options.encoding ? data.toString(options.encoding) : data;
 }
 readFileSync;
@@ -277,7 +281,11 @@ export function writeFileSync(path, data, _options = {}) {
         if (!encodedData) {
             throw new ErrnoError(Errno.EINVAL, 'Data not specified');
         }
-        const file = __addDisposableResource(env_3, _openSync.call(this, typeof path == 'number' ? fd2file(path).path : path.toString(), flag, options.mode, true), false);
+        const file = __addDisposableResource(env_3, _openSync.call(this, typeof path == 'number' ? fd2file(path).path : path.toString(), {
+            flag,
+            mode: options.mode,
+            preserveSymlinks: true,
+        }), false);
         file.writeSync(encodedData, 0, encodedData.byteLength, 0);
         emitChange('change', path.toString());
     }
@@ -308,7 +316,11 @@ export function appendFileSync(filename, data, _options = {}) {
             throw new ErrnoError(Errno.EINVAL, 'Encoding not specified');
         }
         const encodedData = typeof data == 'string' ? Buffer.from(data, options.encoding) : new Uint8Array(data.buffer, data.byteOffset, data.byteLength);
-        const file = __addDisposableResource(env_4, _openSync.call(this, typeof filename == 'number' ? fd2file(filename).path : filename.toString(), flag, options.mode, true), false);
+        const file = __addDisposableResource(env_4, _openSync.call(this, typeof filename == 'number' ? fd2file(filename).path : filename.toString(), {
+            flag,
+            mode: options.mode,
+            preserveSymlinks: true,
+        }), false);
         file.writeSync(encodedData, 0, encodedData.byteLength);
     }
     catch (e_4) {
@@ -560,12 +572,12 @@ export function symlinkSync(target, path, type = 'file') {
         throw ErrnoError.With('EEXIST', path.toString(), 'symlink');
     }
     writeFileSync.call(this, path, target.toString());
-    const file = _openSync.call(this, path, 'r+', 0o644, false);
+    const file = _openSync.call(this, path, { flag: 'r+', mode: 0o644, preserveSymlinks: true });
     file.chmodSync(constants.S_IFLNK);
 }
 symlinkSync;
 export function readlinkSync(path, options) {
-    const value = Buffer.from(_readFileSync.call(this, path.toString(), 'r', false));
+    const value = Buffer.from(_readFileSync.call(this, path.toString(), 'r', true));
     const encoding = typeof options == 'object' ? options === null || options === void 0 ? void 0 : options.encoding : options;
     if (encoding == 'buffer') {
         return value;

package/dist/vfs/types.d.ts

@@ -11,6 +11,21 @@ export interface InternalOptions {
      */
     _isIndirect?: boolean;
 }
+/**
+ * @internal @hidden Used for the internal `_open` functions
+ */
+export interface OpenOptions {
+    flag: fs.OpenMode;
+    mode?: fs.Mode | null;
+    /**
+     * If true, do not resolve symlinks
+     */
+    preserveSymlinks?: boolean;
+    /**
+     * If true, allows opening directories
+     */
+    allowDirectory?: boolean;
+}
 export interface ReaddirOptions extends InternalOptions {
     withFileTypes?: boolean;
     recursive?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "1.7.2",
+	"version": "1.8.0",
 	"description": "A filesystem, anywhere",
 	"funding": {
 		"type": "individual",
@@ -57,8 +57,7 @@
 		"format": "prettier --write .",
 		"format:check": "prettier --check .",
 		"lint": "eslint src tests",
-		"test": "tsx --test --experimental-test-coverage",
-		"pretest": "npm run build",
+		"test": "npx zenfs-test --clean && npx zenfs-test -abcfp && tests/fetch/run.sh && npx zenfs-test --report",
 		"build": "tsc -p tsconfig.json",
 		"build:docs": "typedoc",
 		"dev": "npm run build -- --watch",

package/readme.md

@@ -1,6 +1,6 @@
 # ZenFS
 
-ZenFS is a file system that emulates the [NodeJS filesystem API](http://nodejs.org/api/fs.html). It works using a system of backends, which are used by ZenFS to store and retrieve data. ZenFS can also integrate with other tools.
+ZenFS is a cross-platform library that emulates the [NodeJS filesystem API](http://nodejs.org/api/fs.html). It works using a system of backends, which are used by ZenFS to store and retrieve data. ZenFS can also integrate with other tools.
 
 ## Backends
 
@@ -8,7 +8,7 @@ ZenFS is modular and extensible. The core includes some built-in backends:
 
 -   `InMemory`: Stores files in-memory. This is cleared when the runtime ends (e.g. a user navigating away from a web page or a Node process exiting)
 -   `Overlay`: Use a read-only file system as read-write by overlaying a writable file system on top of it. ([copy-on-write](https://en.wikipedia.org/wiki/Copy-on-write))
--   `Fetch`: Downloads files over HTTP with the `fetch` API (_readonly_)
+-   `Fetch`: Downloads files over HTTP with the `fetch` API
 -   `Port`: Interacts with a remote over a `MessagePort`-like interface (e.g. a worker)
 -   `Passthrough`: Use an existing `node:fs` interface with ZenFS