memfs 3.5.3 → 4.0.0

package/lib/Dirent.js

@@ -1,49 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Dirent = void 0;
-var constants_1 = require("./constants");
-var encoding_1 = require("./encoding");
-var S_IFMT = constants_1.constants.S_IFMT, S_IFDIR = constants_1.constants.S_IFDIR, S_IFREG = constants_1.constants.S_IFREG, S_IFBLK = constants_1.constants.S_IFBLK, S_IFCHR = constants_1.constants.S_IFCHR, S_IFLNK = constants_1.constants.S_IFLNK, S_IFIFO = constants_1.constants.S_IFIFO, S_IFSOCK = constants_1.constants.S_IFSOCK;
+const constants_1 = require("./constants");
+const encoding_1 = require("./encoding");
+const { S_IFMT, S_IFDIR, S_IFREG, S_IFBLK, S_IFCHR, S_IFLNK, S_IFIFO, S_IFSOCK } = constants_1.constants;
 /**
  * A directory entry, like `fs.Dirent`.
  */
-var Dirent = /** @class */ (function () {
-    function Dirent() {
+class Dirent {
+    constructor() {
         this.name = '';
         this.mode = 0;
     }
-    Dirent.build = function (link, encoding) {
-        var dirent = new Dirent();
-        var mode = link.getNode().mode;
+    static build(link, encoding) {
+        const dirent = new Dirent();
+        const { mode } = link.getNode();
         dirent.name = (0, encoding_1.strToEncoding)(link.getName(), encoding);
         dirent.mode = mode;
         return dirent;
-    };
-    Dirent.prototype._checkModeProperty = function (property) {
+    }
+    _checkModeProperty(property) {
         return (this.mode & S_IFMT) === property;
-    };
-    Dirent.prototype.isDirectory = function () {
+    }
+    isDirectory() {
         return this._checkModeProperty(S_IFDIR);
-    };
-    Dirent.prototype.isFile = function () {
+    }
+    isFile() {
         return this._checkModeProperty(S_IFREG);
-    };
-    Dirent.prototype.isBlockDevice = function () {
+    }
+    isBlockDevice() {
         return this._checkModeProperty(S_IFBLK);
-    };
-    Dirent.prototype.isCharacterDevice = function () {
+    }
+    isCharacterDevice() {
         return this._checkModeProperty(S_IFCHR);
-    };
-    Dirent.prototype.isSymbolicLink = function () {
+    }
+    isSymbolicLink() {
         return this._checkModeProperty(S_IFLNK);
-    };
-    Dirent.prototype.isFIFO = function () {
+    }
+    isFIFO() {
         return this._checkModeProperty(S_IFIFO);
-    };
-    Dirent.prototype.isSocket = function () {
+    }
+    isSocket() {
         return this._checkModeProperty(S_IFSOCK);
-    };
-    return Dirent;
-}());
+    }
+}
 exports.Dirent = Dirent;
 exports.default = Dirent;

package/lib/Stats.js

@@ -1,20 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Stats = void 0;
-var constants_1 = require("./constants");
-var getBigInt_1 = require("./getBigInt");
-var S_IFMT = constants_1.constants.S_IFMT, S_IFDIR = constants_1.constants.S_IFDIR, S_IFREG = constants_1.constants.S_IFREG, S_IFBLK = constants_1.constants.S_IFBLK, S_IFCHR = constants_1.constants.S_IFCHR, S_IFLNK = constants_1.constants.S_IFLNK, S_IFIFO = constants_1.constants.S_IFIFO, S_IFSOCK = constants_1.constants.S_IFSOCK;
+const constants_1 = require("./constants");
+const getBigInt_1 = require("./getBigInt");
+const { S_IFMT, S_IFDIR, S_IFREG, S_IFBLK, S_IFCHR, S_IFLNK, S_IFIFO, S_IFSOCK } = constants_1.constants;
 /**
  * Statistics about a file/directory, like `fs.Stats`.
  */
-var Stats = /** @class */ (function () {
-    function Stats() {
-    }
-    Stats.build = function (node, bigint) {
-        if (bigint === void 0) { bigint = false; }
-        var stats = new Stats();
-        var uid = node.uid, gid = node.gid, atime = node.atime, mtime = node.mtime, ctime = node.ctime;
-        var getStatNumber = !bigint ? function (number) { return number; } : getBigInt_1.default;
+class Stats {
+    static build(node, bigint = false) {
+        const stats = new Stats();
+        const { uid, gid, atime, mtime, ctime } = node;
+        const getStatNumber = !bigint ? number => number : getBigInt_1.default;
         // Copy all values on Stats from Node, so that if Node values
         // change, values on Stats would still be the old ones,
         // just like in Node fs.
@@ -31,39 +28,38 @@ var Stats = /** @class */ (function () {
         stats.birthtime = ctime;
         stats.atimeMs = getStatNumber(atime.getTime());
         stats.mtimeMs = getStatNumber(mtime.getTime());
-        var ctimeMs = getStatNumber(ctime.getTime());
+        const ctimeMs = getStatNumber(ctime.getTime());
         stats.ctimeMs = ctimeMs;
         stats.birthtimeMs = ctimeMs;
         stats.dev = getStatNumber(0);
         stats.mode = getStatNumber(node.mode);
         stats.nlink = getStatNumber(node.nlink);
         return stats;
-    };
-    Stats.prototype._checkModeProperty = function (property) {
+    }
+    _checkModeProperty(property) {
         return (Number(this.mode) & S_IFMT) === property;
-    };
-    Stats.prototype.isDirectory = function () {
+    }
+    isDirectory() {
         return this._checkModeProperty(S_IFDIR);
-    };
-    Stats.prototype.isFile = function () {
+    }
+    isFile() {
         return this._checkModeProperty(S_IFREG);
-    };
-    Stats.prototype.isBlockDevice = function () {
+    }
+    isBlockDevice() {
         return this._checkModeProperty(S_IFBLK);
-    };
-    Stats.prototype.isCharacterDevice = function () {
+    }
+    isCharacterDevice() {
         return this._checkModeProperty(S_IFCHR);
-    };
-    Stats.prototype.isSymbolicLink = function () {
+    }
+    isSymbolicLink() {
         return this._checkModeProperty(S_IFLNK);
-    };
-    Stats.prototype.isFIFO = function () {
+    }
+    isFIFO() {
         return this._checkModeProperty(S_IFIFO);
-    };
-    Stats.prototype.isSocket = function () {
+    }
+    isSocket() {
         return this._checkModeProperty(S_IFSOCK);
-    };
-    return Stats;
-}());
+    }
+}
 exports.Stats = Stats;
 exports.default = Stats;

package/lib/encoding.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.strToEncoding = exports.assertEncoding = exports.ENCODING_UTF8 = void 0;
-var buffer_1 = require("./internal/buffer");
-var errors = require("./internal/errors");
+const buffer_1 = require("./internal/buffer");
+const errors = require("./internal/errors");
 exports.ENCODING_UTF8 = 'utf8';
 function assertEncoding(encoding) {
     if (encoding && !buffer_1.Buffer.isEncoding(encoding))

package/lib/fsa/types.d.ts

@@ -0,0 +1,82 @@
+export interface IPermissionStatus {
+    name: string;
+    state: 'granted' | 'denied' | 'prompt';
+}
+export interface IFileSystemHandle {
+    kind: 'file' | 'directory';
+    name: string;
+    isSameEntry(fileSystemHandle: IFileSystemHandle): boolean;
+    queryPermission(fileSystemHandlePermissionDescriptor: NodeFileSystemHandlePermissionDescriptor): IPermissionStatus;
+    remove(options?: {
+        recursive?: boolean;
+    }): Promise<void>;
+    requestPermission(fileSystemHandlePermissionDescriptor: NodeFileSystemHandlePermissionDescriptor): IPermissionStatus;
+}
+export interface NodeFileSystemHandlePermissionDescriptor {
+    mode: 'read' | 'readwrite';
+}
+export interface IFileSystemDirectoryHandle extends IFileSystemHandle {
+    keys(): AsyncIterableIterator<string>;
+    entries(): AsyncIterableIterator<[string, IFileSystemHandle]>;
+    values(): AsyncIterableIterator<IFileSystemHandle>;
+    getDirectoryHandle(name: string, options?: GetDirectoryHandleOptions): Promise<IFileSystemDirectoryHandle>;
+    getFileHandle(name: string, options?: GetFileHandleOptions): Promise<IFileSystemFileHandle>;
+    removeEntry(name: string, options?: RemoveEntryOptions): Promise<void>;
+    resolve(possibleDescendant: IFileSystemHandle): Promise<string[] | null>;
+}
+export interface GetDirectoryHandleOptions {
+    /**
+     * A boolean value, which defaults to `false`. When set to `true` if the directory
+     * is not found, one with the specified name will be created and returned.
+     */
+    create?: boolean;
+}
+export interface GetFileHandleOptions {
+    /**
+     * A Boolean. Default `false`. When set to `true` if the file is not found,
+     * one with the specified name will be created and returned.
+     */
+    create?: boolean;
+}
+export interface RemoveEntryOptions {
+    /**
+     * A boolean value, which defaults to `false`. When set to true entries will
+     * be removed recursively.
+     */
+    recursive?: boolean;
+}
+export interface IFileSystemFileHandle extends IFileSystemHandle {
+    getFile(): Promise<File>;
+    createSyncAccessHandle: undefined | (() => Promise<IFileSystemSyncAccessHandle>);
+    createWritable(options?: CreateWritableOptions): Promise<IFileSystemWritableFileStream>;
+}
+export interface CreateWritableOptions {
+    keepExistingData?: boolean;
+}
+export interface IFileSystemSyncAccessHandle {
+    close(): Promise<void>;
+    flush(): Promise<void>;
+    getSize(): Promise<number>;
+    read(buffer: ArrayBuffer | ArrayBufferView, options?: FileSystemReadWriteOptions): Promise<number>;
+    truncate(newSize: number): Promise<void>;
+    write(buffer: ArrayBuffer | ArrayBufferView | DataView, options?: FileSystemReadWriteOptions): Promise<number>;
+}
+export interface FileSystemReadWriteOptions {
+    /**
+     * A number representing the offset in bytes that the file should be read from.
+     */
+    at?: number;
+}
+export interface IFileSystemWritableFileStream extends WritableStream {
+    seek(position: number): Promise<void>;
+    truncate(size: number): Promise<void>;
+    write(chunk: Data): Promise<void>;
+    write(params: FileSystemWritableFileStreamParams): Promise<void>;
+}
+export interface FileSystemWritableFileStreamParams {
+    type: 'write' | 'truncate' | 'seek';
+    data?: Data;
+    position?: number;
+    size?: number;
+}
+export type Data = ArrayBuffer | ArrayBufferView | Uint8Array | Uint8ClampedArray | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | Float32Array | Float64Array | BigUint64Array | BigInt64Array | DataView | Blob | string;

package/lib/fsa/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/index.d.ts

@@ -1,8 +1,8 @@
 import Stats from './Stats';
 import Dirent from './Dirent';
 import { Volume as _Volume, StatWatcher, FSWatcher, IReadStream, IWriteStream, DirectoryJSON } from './volume';
-import { IPromisesAPI } from './promises';
 import { constants } from './constants';
+import type { FsPromisesApi } from './node/types';
 export { DirectoryJSON };
 export declare const Volume: typeof _Volume;
 export declare const vol: _Volume;
@@ -14,8 +14,22 @@ export interface IFs extends _Volume {
     FSWatcher: new () => FSWatcher;
     ReadStream: new (...args: any[]) => IReadStream;
     WriteStream: new (...args: any[]) => IWriteStream;
-    promises: IPromisesAPI;
+    promises: FsPromisesApi;
     _toUnixTimestamp: any;
 }
 export declare function createFsFromVolume(vol: _Volume): IFs;
 export declare const fs: IFs;
+/**
+ * Creates a new file system instance.
+ *
+ * @param json File system structure expressed as a JSON object.
+ *        Use `null` for empty directories and empty string for empty files.
+ * @param cwd Current working directory. The JSON structure will be created
+ *        relative to this path.
+ * @returns A `memfs` file system instance, which is a drop-in replacement for
+ *          the `fs` module.
+ */
+export declare const memfs: (json?: DirectoryJSON, cwd?: string) => IFs;
+export type IFsWithVolume = IFs & {
+    __vol: _Volume;
+};

package/lib/index.js

@@ -1,48 +1,50 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fs = exports.createFsFromVolume = exports.vol = exports.Volume = void 0;
-var Stats_1 = require("./Stats");
-var Dirent_1 = require("./Dirent");
-var volume_1 = require("./volume");
-var _a = require('fs-monkey/lib/util/lists'), fsSyncMethods = _a.fsSyncMethods, fsAsyncMethods = _a.fsAsyncMethods;
-var constants_1 = require("./constants");
-var F_OK = constants_1.constants.F_OK, R_OK = constants_1.constants.R_OK, W_OK = constants_1.constants.W_OK, X_OK = constants_1.constants.X_OK;
+exports.memfs = exports.fs = exports.createFsFromVolume = exports.vol = exports.Volume = void 0;
+const Stats_1 = require("./Stats");
+const Dirent_1 = require("./Dirent");
+const volume_1 = require("./volume");
+const { fsSyncMethods, fsAsyncMethods } = require('fs-monkey/lib/util/lists');
+const constants_1 = require("./constants");
+const { F_OK, R_OK, W_OK, X_OK } = constants_1.constants;
 exports.Volume = volume_1.Volume;
 // Default volume.
 exports.vol = new volume_1.Volume();
 function createFsFromVolume(vol) {
-    var fs = { F_OK: F_OK, R_OK: R_OK, W_OK: W_OK, X_OK: X_OK, constants: constants_1.constants, Stats: Stats_1.default, Dirent: Dirent_1.default };
+    const fs = { F_OK, R_OK, W_OK, X_OK, constants: constants_1.constants, Stats: Stats_1.default, Dirent: Dirent_1.default };
     // Bind FS methods.
-    for (var _i = 0, fsSyncMethods_1 = fsSyncMethods; _i < fsSyncMethods_1.length; _i++) {
-        var method = fsSyncMethods_1[_i];
+    for (const method of fsSyncMethods)
         if (typeof vol[method] === 'function')
             fs[method] = vol[method].bind(vol);
-    }
-    for (var _a = 0, fsAsyncMethods_1 = fsAsyncMethods; _a < fsAsyncMethods_1.length; _a++) {
-        var method = fsAsyncMethods_1[_a];
+    for (const method of fsAsyncMethods)
         if (typeof vol[method] === 'function')
             fs[method] = vol[method].bind(vol);
-    }
     fs.StatWatcher = vol.StatWatcher;
     fs.FSWatcher = vol.FSWatcher;
     fs.WriteStream = vol.WriteStream;
     fs.ReadStream = vol.ReadStream;
     fs.promises = vol.promises;
     fs._toUnixTimestamp = volume_1.toUnixTimestamp;
+    fs.__vol = vol;
     return fs;
 }
 exports.createFsFromVolume = createFsFromVolume;
 exports.fs = createFsFromVolume(exports.vol);
-module.exports = __assign(__assign({}, module.exports), exports.fs);
+/**
+ * Creates a new file system instance.
+ *
+ * @param json File system structure expressed as a JSON object.
+ *        Use `null` for empty directories and empty string for empty files.
+ * @param cwd Current working directory. The JSON structure will be created
+ *        relative to this path.
+ * @returns A `memfs` file system instance, which is a drop-in replacement for
+ *          the `fs` module.
+ */
+const memfs = (json = {}, cwd = '/') => {
+    const volume = exports.Volume.fromJSON(json, cwd);
+    const fs = createFsFromVolume(volume);
+    return fs;
+};
+exports.memfs = memfs;
+module.exports = Object.assign(Object.assign({}, module.exports), exports.fs);
 module.exports.semantic = true;

package/lib/internal/buffer.js

@@ -1,25 +1,12 @@
 "use strict";
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.bufferFrom = exports.bufferAllocUnsafe = exports.Buffer = void 0;
-var buffer_1 = require("buffer");
+const buffer_1 = require("buffer");
 Object.defineProperty(exports, "Buffer", { enumerable: true, get: function () { return buffer_1.Buffer; } });
-function bufferV0P12Ponyfill(arg0) {
-    var args = [];
-    for (var _i = 1; _i < arguments.length; _i++) {
-        args[_i - 1] = arguments[_i];
-    }
-    return new (buffer_1.Buffer.bind.apply(buffer_1.Buffer, __spreadArray([void 0, arg0], args, false)))();
+function bufferV0P12Ponyfill(arg0, ...args) {
+    return new buffer_1.Buffer(arg0, ...args);
 }
-var bufferAllocUnsafe = buffer_1.Buffer.allocUnsafe || bufferV0P12Ponyfill;
+const bufferAllocUnsafe = buffer_1.Buffer.allocUnsafe || bufferV0P12Ponyfill;
 exports.bufferAllocUnsafe = bufferAllocUnsafe;
-var bufferFrom = buffer_1.Buffer.from || bufferV0P12Ponyfill;
+const bufferFrom = buffer_1.Buffer.from || bufferV0P12Ponyfill;
 exports.bufferFrom = bufferFrom;