@tauri-apps/plugin-fs 2.2.1 → 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

@@ -708,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:') {
@@ -732,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.js

@@ -706,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:') {
@@ -730,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.1",
+  "version": "2.3.0",
   "description": "Access the file system.",
   "license": "MIT OR Apache-2.0",
   "authors": [