@zenfs/core 0.4.1 → 0.4.2

package/dist/stats.d.ts

@@ -202,3 +202,19 @@ export declare class BigIntStats extends StatsCommon<bigint> implements Node.Big
      */
     static clone(stats: BigIntStats | Stats): BigIntStats;
 }
+/**
+ * @returns true if stats is a file.
+ */
+export declare function isFile(stats: StatsLike): boolean;
+/**
+ * @returns True if stats is a directory.
+ */
+export declare function isDirectory(stats: StatsLike): boolean;
+/**
+ * @returns true if stats is a symbolic link
+ */
+export declare function isSymbolicLink(stats: StatsLike): boolean;
+export declare function isSocket(): boolean;
+export declare function isBlockDevice(): boolean;
+export declare function isCharacterDevice(): boolean;
+export declare function isFIFO(): boolean;

package/dist/stats.js

@@ -246,3 +246,33 @@ export class BigIntStats extends StatsCommon {
     }
 }
 BigIntStats;
+/**
+ * @returns true if stats is a file.
+ */
+export function isFile(stats) {
+    return (Number(stats.mode) & S_IFMT) === S_IFREG;
+}
+/**
+ * @returns True if stats is a directory.
+ */
+export function isDirectory(stats) {
+    return (Number(stats.mode) & S_IFMT) === S_IFDIR;
+}
+/**
+ * @returns true if stats is a symbolic link
+ */
+export function isSymbolicLink(stats) {
+    return (Number(stats.mode) & S_IFMT) === S_IFLNK;
+}
+export function isSocket() {
+    return false;
+}
+export function isBlockDevice() {
+    return false;
+}
+export function isCharacterDevice() {
+    return false;
+}
+export function isFIFO() {
+    return false;
+}

package/license.md

@@ -22,8 +22,8 @@ SOFTWARE.
 
 This license applies to all parts of ZenFS, except for the following items:
 
-- The test fixtures located in `test/fixtures/node`. Their license follows:
-  """
+-   The test fixtures located in `test/fixtures/node`. Their license follows:
+    """
     Copyright Joyent, Inc. and other Node contributors. All rights reserved.
     Permission is hereby granted, free of charge, to any person obtaining a copy
     of this software and associated documentation files (the "Software"), to
@@ -42,4 +42,4 @@ This license applies to all parts of ZenFS, except for the following items:
     LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
     FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
     IN THE SOFTWARE.
-  """
+    """

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@zenfs/core",
-	"version": "0.4.1",
+	"version": "0.4.2",
 	"description": "A filesystem in your browser",
 	"main": "dist/index.js",
 	"types": "dist",
@@ -41,9 +41,9 @@
 		}
 	},
 	"scripts": {
-		"format": "prettier --write src test",
-		"format:check": "prettier --check src test",
-		"lint": "eslint src test && tsc -p tsconfig.json --noEmit",
+		"format": "prettier --write .",
+		"format:check": "prettier --check .",
+		"lint": "eslint src tests && tsc -p tsconfig.json --noEmit",
 		"test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest",
 		"build": "node scripts/build.js",
 		"build:docs": "typedoc --out docs --name ZenFS src/index.ts",
@@ -65,7 +65,7 @@
 		"esbuild": "^0.17.18",
 		"eslint": "^8.36.0",
 		"jest": "^29.5.0",
-		"prettier": "^2.8.7",
+		"prettier": "^3.2.5",
 		"ts-jest": "^29.1.0",
 		"typedoc": "^0.25.1",
 		"typescript": "^4.9.5"

package/readme.md

@@ -1,27 +1,25 @@
 # ZenFS
 
-ZenFS is a file system that emulates the [Node JS file system API](http://nodejs.org/api/fs.html).
+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 nicely with other tools.
+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 fork of [BrowserFS](https://github.com/jvilk/BrowserFS).
 
 ## Backends
 
-ZenFS is highly extensible, and includes a few built-in backends:
+ZenFS is modular and extensible. The core includes a few built-in backends:
 
--   `InMemory`: Stores files in-memory. It is a temporary file store that clears when the user navigates away.
--   `Overlay`: Mount a read-only file system as read-write by overlaying a writable file system on top of it. Like Docker's overlayfs, it will only write changed files to the writable file system.
--   `AsyncMirror`: Use an asynchronous backend synchronously. Invaluable for Emscripten; let your Emscripten applications write to larger file stores with no additional effort!
+-   `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 read-only file system as read-write by overlaying a writable file system on top of it.
+-   `AsyncMirror`: Use an asynchronous backend synchronously. This is very helpful for asynchronous backends
 
 > [!NOTE]
 > When constructed, `AsyncMirror` loads the entire contents of the async file system into a synchronous backend. It performs operations on the synchronous file system and then queues them to be mirrored onto the asynchronous backend.
 
-More backends can be defined by separate libraries, as long as they implement `FileSystem`.
+ZenFS supports a number of other backends. Many are provided as seperate packages under `@zenfs`. More backends can be defined by separate libraries by extending the `FileSystem` class and/or providing a `Backend` object.
 
-ZenFS supports a number of other backends. Many are provided as seperate packages under `@zenfs`.
-
-For more information, see the [API documentation for ZenFS](https://zen-fs.github.io/core).
+For more information, see the [docs](https://zen-fs.github.io/core).
 
 ## Installing
 
@@ -32,10 +30,12 @@ npm install @zenfs/core
 ## Usage
 
 > [!NOTE]
-> The examples are written in ESM. If you are using CJS, you can `require` the package. If running in a browser you can add a script tag to your HTML pointing to the `browser.min.js` and use ZenFS via the global `ZenFS` object.
+> The examples are written in ESM.  
+> If you are using CJS, you can `require` the package.  
+> If using a browser environment without support for `type=module` in `script` tags, you can add a `script` tag to your HTML pointing to the `browser.min.js` and use ZenFS with the global `ZenFS` object.
 
 ```js
-import fs from '@zenfs/core';
+import fs from '@zenfs/core'; // You can also use the named export, `fs`
 
 fs.writeFileSync('/test.txt', 'Cool, I can do this in any JS environment (including browsers)!');