@tauri-apps/plugin-fs 2.2.0 → 2.3.0

package/README.md

@@ -68,9 +68,9 @@ fn main() {
 Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
 
 ```javascript
-import { metadata } from '@tauri-apps/plugin-fs'
+import { stat } from '@tauri-apps/plugin-fs'
 
-await metadata('/path/to/file')
+await stat('/path/to/file')
 ```
 
 ## Contributing

package/dist-js/index.cjs

@@ -14,7 +14,7 @@ var core = require('@tauri-apps/api/core');
  * This module prevents path traversal, not allowing parent directory accessors to be used
  * (i.e. "/usr/path/to/../file" or "../path/to/file" paths are not allowed).
  * Paths accessed with this API must be either relative to one of the {@link BaseDirectory | base directories}
- * or created with the {@link https://v2.tauri.app/reference/javascript/api/namespacepath | path API}.
+ * or created with the {@link https://v2.tauri.app/reference/javascript/api/namespacepath/ | path API}.
  *
  * The API has a scope configuration that forces you to restrict the paths that can be accessed using glob patterns.
  *
@@ -349,8 +349,8 @@ async function open(path, options) {
  * @since 2.0.0
  */
 async function copyFile(fromPath, toPath, options) {
-    if ((fromPath instanceof URL && fromPath.protocol !== 'file:') ||
-        (toPath instanceof URL && toPath.protocol !== 'file:')) {
+    if ((fromPath instanceof URL && fromPath.protocol !== 'file:')
+        || (toPath instanceof URL && toPath.protocol !== 'file:')) {
         throw new TypeError('Must be a file URL.');
     }
     await core.invoke('plugin:fs|copy_file', {
@@ -542,8 +542,8 @@ async function remove(path, options) {
  * @since 2.0.0
  */
 async function rename(oldPath, newPath, options) {
-    if ((oldPath instanceof URL && oldPath.protocol !== 'file:') ||
-        (newPath instanceof URL && newPath.protocol !== 'file:')) {
+    if ((oldPath instanceof URL && oldPath.protocol !== 'file:')
+        || (newPath instanceof URL && newPath.protocol !== 'file:')) {
         throw new TypeError('Must be a file URL.');
     }
     await core.invoke('plugin:fs|rename', {
@@ -642,10 +642,19 @@ async function writeFile(path, data, options) {
     }
     if (data instanceof ReadableStream) {
         const file = await open(path, options);
-        for await (const chunk of data) {
-            await file.write(chunk);
+        const reader = data.getReader();
+        try {
+            while (true) {
+                const { done, value } = await reader.read();
+                if (done)
+                    break;
+                await file.write(value);
+            }
+        }
+        finally {
+            reader.releaseLock();
+            await file.close();
         }
-        await file.close();
     }
     else {
         await core.invoke('plugin:fs|write_file', data, {
@@ -699,20 +708,9 @@ async function exists(path, options) {
         options
     });
 }
-async function unwatch(rid) {
-    await core.invoke('plugin:fs|unwatch', { rid });
+class Watcher extends core.Resource {
 }
-/**
- * Watch changes (after a delay) on files or directories.
- *
- * @since 2.0.0
- */
-async function watch(paths, cb, options) {
-    const opts = {
-        recursive: false,
-        delayMs: 2000,
-        ...options
-    };
+async function watchInternal(paths, cb, options) {
     const watchPaths = Array.isArray(paths) ? paths : [paths];
     for (const path of watchPaths) {
         if (path instanceof URL && path.protocol !== 'file:') {
@@ -723,40 +721,37 @@ async function watch(paths, cb, options) {
     onEvent.onmessage = cb;
     const rid = await core.invoke('plugin:fs|watch', {
         paths: watchPaths.map((p) => (p instanceof URL ? p.toString() : p)),
-        options: opts,
+        options,
         onEvent
     });
+    const watcher = new Watcher(rid);
     return () => {
-        void unwatch(rid);
+        void watcher.close();
     };
 }
+// TODO: Return `Watcher` instead in v3
+/**
+ * Watch changes (after a delay) on files or directories.
+ *
+ * @since 2.0.0
+ */
+async function watch(paths, cb, options) {
+    return await watchInternal(paths, cb, {
+        delayMs: 2000,
+        ...options
+    });
+}
+// TODO: Return `Watcher` instead in v3
 /**
  * Watch changes on files or directories.
  *
  * @since 2.0.0
  */
 async function watchImmediate(paths, cb, options) {
-    const opts = {
-        recursive: false,
+    return await watchInternal(paths, cb, {
         ...options,
-        delayMs: null
-    };
-    const watchPaths = Array.isArray(paths) ? paths : [paths];
-    for (const path of watchPaths) {
-        if (path instanceof URL && path.protocol !== 'file:') {
-            throw new TypeError('Must be a file URL.');
-        }
-    }
-    const onEvent = new core.Channel();
-    onEvent.onmessage = cb;
-    const rid = await core.invoke('plugin:fs|watch', {
-        paths: watchPaths.map((p) => (p instanceof URL ? p.toString() : p)),
-        options: opts,
-        onEvent
+        delayMs: undefined
     });
-    return () => {
-        void unwatch(rid);
-    };
 }
 /**
  * Get the size of a file or directory. For files, the `stat` functions can be used as well.

package/dist-js/index.d.ts

@@ -6,7 +6,7 @@
  * This module prevents path traversal, not allowing parent directory accessors to be used
  * (i.e. "/usr/path/to/../file" or "../path/to/file" paths are not allowed).
  * Paths accessed with this API must be either relative to one of the {@link BaseDirectory | base directories}
- * or created with the {@link https://v2.tauri.app/reference/javascript/api/namespacepath | path API}.
+ * or created with the {@link https://v2.tauri.app/reference/javascript/api/namespacepath/ | path API}.
  *
  * The API has a scope configuration that forces you to restrict the paths that can be accessed using glob patterns.
  *

package/dist-js/index.js

@@ -12,7 +12,7 @@ import { Resource, invoke, Channel } from '@tauri-apps/api/core';
  * This module prevents path traversal, not allowing parent directory accessors to be used
  * (i.e. "/usr/path/to/../file" or "../path/to/file" paths are not allowed).
  * Paths accessed with this API must be either relative to one of the {@link BaseDirectory | base directories}
- * or created with the {@link https://v2.tauri.app/reference/javascript/api/namespacepath | path API}.
+ * or created with the {@link https://v2.tauri.app/reference/javascript/api/namespacepath/ | path API}.
  *
  * The API has a scope configuration that forces you to restrict the paths that can be accessed using glob patterns.
  *
@@ -347,8 +347,8 @@ async function open(path, options) {
  * @since 2.0.0
  */
 async function copyFile(fromPath, toPath, options) {
-    if ((fromPath instanceof URL && fromPath.protocol !== 'file:') ||
-        (toPath instanceof URL && toPath.protocol !== 'file:')) {
+    if ((fromPath instanceof URL && fromPath.protocol !== 'file:')
+        || (toPath instanceof URL && toPath.protocol !== 'file:')) {
         throw new TypeError('Must be a file URL.');
     }
     await invoke('plugin:fs|copy_file', {
@@ -540,8 +540,8 @@ async function remove(path, options) {
  * @since 2.0.0
  */
 async function rename(oldPath, newPath, options) {
-    if ((oldPath instanceof URL && oldPath.protocol !== 'file:') ||
-        (newPath instanceof URL && newPath.protocol !== 'file:')) {
+    if ((oldPath instanceof URL && oldPath.protocol !== 'file:')
+        || (newPath instanceof URL && newPath.protocol !== 'file:')) {
         throw new TypeError('Must be a file URL.');
     }
     await invoke('plugin:fs|rename', {
@@ -640,10 +640,19 @@ async function writeFile(path, data, options) {
     }
     if (data instanceof ReadableStream) {
         const file = await open(path, options);
-        for await (const chunk of data) {
-            await file.write(chunk);
+        const reader = data.getReader();
+        try {
+            while (true) {
+                const { done, value } = await reader.read();
+                if (done)
+                    break;
+                await file.write(value);
+            }
+        }
+        finally {
+            reader.releaseLock();
+            await file.close();
         }
-        await file.close();
     }
     else {
         await invoke('plugin:fs|write_file', data, {
@@ -697,20 +706,9 @@ async function exists(path, options) {
         options
     });
 }
-async function unwatch(rid) {
-    await invoke('plugin:fs|unwatch', { rid });
+class Watcher extends Resource {
 }
-/**
- * Watch changes (after a delay) on files or directories.
- *
- * @since 2.0.0
- */
-async function watch(paths, cb, options) {
-    const opts = {
-        recursive: false,
-        delayMs: 2000,
-        ...options
-    };
+async function watchInternal(paths, cb, options) {
     const watchPaths = Array.isArray(paths) ? paths : [paths];
     for (const path of watchPaths) {
         if (path instanceof URL && path.protocol !== 'file:') {
@@ -721,40 +719,37 @@ async function watch(paths, cb, options) {
     onEvent.onmessage = cb;
     const rid = await invoke('plugin:fs|watch', {
         paths: watchPaths.map((p) => (p instanceof URL ? p.toString() : p)),
-        options: opts,
+        options,
         onEvent
     });
+    const watcher = new Watcher(rid);
     return () => {
-        void unwatch(rid);
+        void watcher.close();
     };
 }
+// TODO: Return `Watcher` instead in v3
+/**
+ * Watch changes (after a delay) on files or directories.
+ *
+ * @since 2.0.0
+ */
+async function watch(paths, cb, options) {
+    return await watchInternal(paths, cb, {
+        delayMs: 2000,
+        ...options
+    });
+}
+// TODO: Return `Watcher` instead in v3
 /**
  * Watch changes on files or directories.
  *
  * @since 2.0.0
  */
 async function watchImmediate(paths, cb, options) {
-    const opts = {
-        recursive: false,
+    return await watchInternal(paths, cb, {
         ...options,
-        delayMs: null
-    };
-    const watchPaths = Array.isArray(paths) ? paths : [paths];
-    for (const path of watchPaths) {
-        if (path instanceof URL && path.protocol !== 'file:') {
-            throw new TypeError('Must be a file URL.');
-        }
-    }
-    const onEvent = new Channel();
-    onEvent.onmessage = cb;
-    const rid = await invoke('plugin:fs|watch', {
-        paths: watchPaths.map((p) => (p instanceof URL ? p.toString() : p)),
-        options: opts,
-        onEvent
+        delayMs: undefined
     });
-    return () => {
-        void unwatch(rid);
-    };
 }
 /**
  * Get the size of a file or directory. For files, the `stat` functions can be used as well.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tauri-apps/plugin-fs",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Access the file system.",
   "license": "MIT OR Apache-2.0",
   "authors": [