browser-fs-access - npm Package Compare versions

Comparing version 0.31.1 to 0.31.2

package.json

 {
   "name": "browser-fs-access",
-  "version": "0.31.1",
+  "version": "0.31.2",
   "description": "File System Access API with legacy fallback in the browser.",
@@ -11,3 +11,4 @@ "type": "module",
       "import": "./dist/index.modern.js",
-      "require": "./dist/index.cjs"
+      "require": "./dist/index.cjs",
+      "types": "./index.d.ts"
     },
@@ -53,8 +54,8 @@ "./package.json": "./package.json"
   "devDependencies": {
-    "eslint": "^8.24.0",
+    "eslint": "^8.31.0",
     "eslint-config-google": "^0.14.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-prettier": "^8.6.0",
     "http-server": "^14.1.1",
     "microbundle": "^0.15.1",
-    "prettier": "^2.7.1",
+    "prettier": "^2.8.2",
     "shx": "^0.3.4"
@@ -61,0 +62,0 @@ },

README.md

@@ -23,3 +23,3 @@ # Browser-FS-Access
 
-## Usage Example
+## Usage Examples
 
@@ -29,5 +29,9 @@ The module feature-detects support for the File System Access API and
 
+### Importing what you need
+
+Import only the features that you need. In the code sample below, all
+features are loaded. The imported methods will use the File System
+Access API or a fallback implementation.
+
 ```js
-// The imported methods will use the File System
-// Access API or a fallback implementation.
 import {
@@ -39,65 +43,93 @@ fileOpen,
 } from 'https://unpkg.com/browser-fs-access';
+```
 
-(async () => {
-  if (supported) {
-    console.log('Using the File System Access API.');
-  } else {
-    console.log('Using the fallback implementation.');
-  }
+### Feature detection
 
-  // Open a file.
-  const blob = await fileOpen({
-    mimeTypes: ['image/*'],
-  });
+You can check `supported` to see if the File System Access API is
+supported.
 
-  // Open multiple files.
-  const blobs = await fileOpen({
-    mimeTypes: ['image/*'],
+```js
+if (supported) {
+  console.log('Using the File System Access API.');
+} else {
+  console.log('Using the fallback implementation.');
+}
+```
+
+### Opening a file
+
+```js
+const blob = await fileOpen({
+  mimeTypes: ['image/*'],
+});
+```
+
+### Opening multiple files
+
+```js
+const blobs = await fileOpen({
+  mimeTypes: ['image/*'],
+  multiple: true,
+});
+```
+
+### Opening files of different MIME types
+
+```js
+const blobs = await fileOpen([
+  {
+    description: 'Image files',
+    mimeTypes: ['image/jpg', 'image/png', 'image/gif', 'image/webp'],
+    extensions: ['.jpg', '.jpeg', '.png', '.gif', '.webp'],
     multiple: true,
-  });
+  },
+  {
+    description: 'Text files',
+    mimeTypes: ['text/*'],
+    extensions: ['.txt'],
+  },
+]);
+```
 
-  // Open files of different MIME types.
-  const blobs = await fileOpen([
-    {
-      description: 'Image files',
-      mimeTypes: ['image/jpg', 'image/png', 'image/gif', 'image/webp'],
-      extensions: ['.jpg', '.jpeg', '.png', '.gif', '.webp'],
-      multiple: true,
-    },
-    {
-      description: 'Text files',
-      mimeTypes: ['text/*'],
-      extensions: ['.txt'],
-    },
-  ]);
+### Opening all files in a directory
 
-  // Open all files in a directory,
-  // recursively including subdirectories.
-  const blobsInDirectory = await directoryOpen({
-    recursive: true,
-  });
+Optionally, you can recursively include subdirectories.
 
-  // Save a file.
-  await fileSave(blob, {
-    fileName: 'Untitled.png',
-    extensions: ['.png'],
-  });
+```js
+const blobsInDirectory = await directoryOpen({
+  recursive: true,
+});
+```
 
-  // Save a `Response` that will be streamed.
-  const response = await fetch('foo.png');
-  await fileSave(response, {
-    fileName: 'foo.png',
-    extensions: ['.png'],
-  });
+### Saving a file
 
-  // Save a `Promise<Blob>` that will be streamed.
-  // No need to `await` the `Blob` to be created.
-  const blob = createBlobAsyncWhichMightTakeLonger(someData);
-  await fileSave(response, {
-    fileName: 'Untitled.png',
-    extensions: ['.png'],
-  });
-})();
+```js
+await fileSave(blob, {
+  fileName: 'Untitled.png',
+  extensions: ['.png'],
+});
 ```
 
+### Saving a `Response` that will be streamed
+
+```js
+const response = await fetch('foo.png');
+await fileSave(response, {
+  fileName: 'foo.png',
+  extensions: ['.png'],
+});
+```
+
+### Saving a `Promise<Blob>` that will be streamed.
+
+No need to `await` the `Blob` to be created.
+
+```js
+const blob = createBlobAsyncWhichMightTakeLonger(someData);
+await fileSave(blob, {
+  fileName: 'Untitled.png',
+  extensions: ['.png'],
+});
+```
+
 ## API Documentation
@@ -104,0 +136,0 @@

No alert changes

Improved metrics

Total package byte prevSize

46494

increased by0.52%

Number of lines in readme file

270

increased by13.45%

No dependency changes