@anabranch/fs 0.1.0

package/esm/fs/watch.js

@@ -0,0 +1,37 @@
+import { existsSync, watch as fsWatch } from "node:fs";
+import { join } from "node:path";
+import { fileURLToPath } from "node:url";
+import { Channel } from "../anabranch/index.js";
+import { nodeErrorToFSError, } from "./errors.js";
+/**
+ * Watches `path` for file-system changes, yielding a {@link FsEvent} for each.
+ *
+ * Uses a push-based queue internally so events are never dropped between yields.
+ * Cancel the stream to stop watching (e.g. via `take`, breaking `for await`, or
+ * returning from the generator).
+ *
+ * Note: on some platforms `rename` events cannot distinguish creation from
+ * deletion without a stat check. This implementation infers the kind by
+ * checking whether the file still exists at event time.
+ */
+export function watch(path, options) {
+    const watchPath = path instanceof URL ? fileURLToPath(path) : path;
+    const watcher = fsWatch(path, { recursive: options?.recursive ?? true, persistent: false }, (eventType, filename) => {
+        const name = filename;
+        const fullPath = name ? join(watchPath, name) : watchPath;
+        let kind;
+        if (eventType === "rename") {
+            kind = existsSync(fullPath) ? "create" : "remove";
+        }
+        else {
+            kind = "modify";
+        }
+        channel.send({ kind, paths: [fullPath] });
+    });
+    const channel = new Channel({
+        onClose: () => watcher.close(),
+    });
+    watcher.once("error", (err) => channel.fail(nodeErrorToFSError(err, path)));
+    watcher.once("close", () => channel.close());
+    return channel;
+}

package/esm/fs/write.d.ts

@@ -0,0 +1,16 @@
+import { Task } from "../anabranch/index.js";
+import { type IsDirectory, type NotFound, type PermissionDenied, type Unknown, type WriteError } from "./errors.js";
+/**
+ * Writes a UTF-8 string to a file, creating or overwriting it.
+ */
+export declare function writeTextFile(path: string | URL, content: string): Task<void, WriteFileError>;
+/**
+ * Writes a `Uint8Array` to a file, creating or overwriting it.
+ */
+export declare function writeFile(path: string | URL, data: Uint8Array): Task<void, WriteFileError>;
+/**
+ * Serialises `value` as JSON and writes it to a file, creating or overwriting it.
+ */
+export declare function writeJson(path: string | URL, value: unknown): Task<void, WriteFileError>;
+export type WriteFileError = NotFound | IsDirectory | PermissionDenied | WriteError | Unknown;
+//# sourceMappingURL=write.d.ts.map

package/esm/fs/write.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write.d.ts","sourceRoot":"","sources":["../../src/fs/write.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EACL,KAAK,WAAW,EAEhB,KAAK,QAAQ,EACb,KAAK,gBAAgB,EACrB,KAAK,OAAO,EACZ,KAAK,UAAU,EAChB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,MAAM,GAAG,GAAG,EAClB,OAAO,EAAE,MAAM,GACd,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAQ5B;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,GAAG,GAAG,EAClB,IAAI,EAAE,UAAU,GACf,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAQ5B;AAED;;GAEG;AACH,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,GAAG,GAAG,EAClB,KAAK,EAAE,OAAO,GACb,IAAI,CAAC,IAAI,EAAE,cAAc,CAAC,CAQ5B;AAED,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,WAAW,GACX,gBAAgB,GAChB,UAAU,GACV,OAAO,CAAC"}

package/esm/fs/write.js

@@ -0,0 +1,42 @@
+import { writeFile as fsWriteFile } from "node:fs/promises";
+import { Task } from "../anabranch/index.js";
+import { nodeErrorToFSError, } from "./errors.js";
+/**
+ * Writes a UTF-8 string to a file, creating or overwriting it.
+ */
+export function writeTextFile(path, content) {
+    return Task.of(async () => {
+        try {
+            await fsWriteFile(path, content, "utf8");
+        }
+        catch (error) {
+            throw nodeErrorToFSError(error, path);
+        }
+    });
+}
+/**
+ * Writes a `Uint8Array` to a file, creating or overwriting it.
+ */
+export function writeFile(path, data) {
+    return Task.of(async () => {
+        try {
+            await fsWriteFile(path, data);
+        }
+        catch (error) {
+            throw nodeErrorToFSError(error, path);
+        }
+    });
+}
+/**
+ * Serialises `value` as JSON and writes it to a file, creating or overwriting it.
+ */
+export function writeJson(path, value) {
+    return Task.of(async () => {
+        try {
+            await fsWriteFile(path, JSON.stringify(value), "utf8");
+        }
+        catch (error) {
+            throw nodeErrorToFSError(error, path);
+        }
+    });
+}

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

package/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "@anabranch/fs",
+  "version": "0.1.0",
+  "description": "Streaming file-system utilities for the anabranch ecosystem",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/frodi-karlsson/anabranch.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/frodi-karlsson/anabranch/issues"
+  },
+  "module": "./esm/fs/index.js",
+  "exports": {
+    ".": {
+      "import": "./esm/fs/index.js"
+    }
+  },
+  "scripts": {},
+  "dependencies": {
+    "anabranch": "^0"
+  },
+  "_generatedBy": "dnt@dev"
+}