@zenfs/dom 0.0.2 → 0.0.4

package/dist/fetch.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" resolution-mode="require"/>
 export declare const fetchIsAvailable: boolean;
 /**
  * Asynchronously download a file as a buffer or a JSON object.
@@ -7,9 +6,9 @@ export declare const fetchIsAvailable: boolean;
  * constants.
  * @hidden
  */
-export declare function fetchFile(p: string, type: 'buffer'): Promise<Buffer>;
+export declare function fetchFile(p: string, type: 'buffer'): Promise<Uint8Array>;
 export declare function fetchFile(p: string, type: 'json'): Promise<any>;
-export declare function fetchFile(p: string, type: string): Promise<any>;
+export declare function fetchFile(p: string, type: 'buffer' | 'json'): Promise<any>;
 /**
  * Asynchronously retrieves the size of the given file in bytes.
  * @hidden

package/dist/fetch.js

@@ -10,7 +10,6 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 /**
  * Contains utility methods for network I/O (using fetch)
  */
-import { Buffer } from 'buffer';
 import { ApiError, ErrorCode } from '@zenfs/core/ApiError.js';
 export const fetchIsAvailable = typeof fetch !== 'undefined' && fetch !== null;
 /**
@@ -27,11 +26,10 @@ export function fetchFile(p, type) {
         }
         switch (type) {
             case 'buffer':
-                const buf = yield response.arrayBuffer().catch(convertError);
-                return Buffer.from(buf);
+                const arrayBuffer = yield response.arrayBuffer().catch(convertError);
+                return new Uint8Array(arrayBuffer);
             case 'json':
-                const json = yield response.json().catch(convertError);
-                return json;
+                return response.json().catch(convertError);
             default:
                 throw new ApiError(ErrorCode.EINVAL, 'Invalid download type: ' + type);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenfs/dom",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "description": "DOM backends for ZenFS",
   "main": "dist/index.js",
   "types": "dist",
@@ -26,35 +26,31 @@
   "exports": {
     "./*": "./dist/*"
   },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*"
+      ]
+    }
+  },
   "scripts": {
     "format": "prettier --write src",
     "format:check": "prettier --check src",
     "lint": "eslint src",
-    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules npx jest",
     "build": "node scripts/build.mjs",
-    "build:docs": "typedoc --out docs --name ZenFS src/index.ts",
+    "build:docs": "typedoc --out docs --name 'ZenFS DOM' src/index.ts",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@jest/globals": "^29.5.0",
-    "@types/jest": "^29.5.1",
-    "@types/node": "^14.18.62",
     "@typescript-eslint/eslint-plugin": "^5.55.0",
     "@typescript-eslint/parser": "^5.55.0",
-    "archiver": "~2.1.1",
-    "buffer": "~5.1.0",
-    "cross-env": "^7.0.3",
     "esbuild": "^0.17.18",
-    "esbuild-plugin-polyfill-node": "^0.3.0",
     "eslint": "^8.36.0",
-    "jest": "^29.5.0",
-    "path": "^0.12.7",
     "prettier": "^2.8.7",
-    "ts-jest": "^29.1.0",
     "typedoc": "^0.25.1",
     "typescript": "5.2.2"
   },
   "dependencies": {
-    "@zenfs/core": "^0.0.6"
+    "@zenfs/core": "^0.0.11"
   }
 }

package/readme.md

@@ -19,22 +19,15 @@ For more information, see the [API documentation](https://zen-fs.github.io/fs-do
 npm install @zenfs/fs-dom
 ```
 
-## Building
-
--   Make sure you have Node and NPM installed. You must have Node v18 or newer.
--   Install dependencies with `npm install`
--   Build using `npm run build`
--   You can find the built code in `dist`.
-
 ## Usage
 
-> 🛈 The examples are written in ESM. If you are using CJS, you can `require` the package. If running in a borwser you can add a script tag to your HTML pointing to the `browser.min.js` and use ZenFS DOM via the global `ZenFS_DOM` object.
+> 🛈 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 DOM via the global `ZenFS_DOM` object.
 
 You can use DOM backends, though you must register them if you plan on using `configure`:
 
 ```js
 import { configure, fs, registerBackend } from '@zenfs/core';
-import { Storage } '@zenfs/fs-dom';
+import { Storage } from '@zenfs/fs-dom';
 
 registerBackend(Storage);
 await configure({ fs: 'Storage', options: { storage: localStorage } });
@@ -46,7 +39,3 @@ if (!fs.existsSync('/test.txt')) {
 const contents = fs.readFileSync('/test.txt', 'utf-8');
 console.log(contents);
 ```
-
-### Testing
-
-Run unit tests with `npm test`.