@logtape/logtape 0.1.0-dev.16 → 0.1.0-dev.17

package/README.md

@@ -241,65 +241,28 @@ in the API reference for more details.
 
 ### File sink
 
-LogTape provides a platform-independent file sink.  You can use it by providing
-a platform-specific file driver for Deno or Node.js.  Here's an example of
-a file sink that writes log messages to a file:
-
-~~~~ typescript
-// Deno
-import { type FileSinkDriver, getFileSink } from "@logtape/logtape";
+> [!NOTE]
+> File sink is unavailable in the browser environment.
 
-const driver: FileSinkDriver<Deno.FsFile> = {
-  openSync(path: string) {
-    return Deno.openSync(path, { create: true, append: true });
-  },
-  writeSync(fd, chunk) {
-    fd.writeSync(chunk);
-  },
-  flushSync(fd) {
-    fd.syncSync();
-  },
-  closeSync(fd) {
-    fd.close();
-  },
-};
-
-configure({
-  sinks: {
-    file: getFileSink("my-app.log", driver),
-  },
-  // Omitted for brevity
-});
-~~~~
+LogTape provides a file sink as well.  Here's an example of a file sink that
+writes log messages to a file:
 
 ~~~~ typescript
-// Node.js or Bun
-import fs from "node:fs";
-import { type FileSinkDriver, getFileSink } from "@logtape/logtape";
-
-const driver: FileSinkDriver<number> = {
-  openSync(path: string) {
-    return fs.openSync(path, "a");
-  },
-  writeSync: fs.writeSync,
-  flushSync: fs.fsyncSync,
-  closeSync: fs.closeSync,
-};
+import { getFileSink } from "@logtape/logtape";
 
 configure({
   sinks: {
-    file: getFileSink("my-app.log", driver),
+    file: getFileSink("my-app.log"),
   },
   // Omitted for brevity
 });
 ~~~~
 
-See also [`getFileSink()`] function, [`FileSinkOptions`] interface, and
-[`FileSinkDriver`] interface in the API reference for more details.
+See also [`getFileSink()`] function and [`FileSinkOptions`] interface
+in the API reference for more details.
 
 [`getFileSink()`]: https://jsr.io/@logtape/logtape/doc/~/getFileSink
 [`FileSinkOptions`]: https://jsr.io/@logtape/logtape/doc/~/FileSinkOptions
-[`FileSinkDriver`]: https://jsr.io/@logtape/logtape/doc/~/FileSinkDriver
 
 ### Text formatter
 

package/esm/filesink.node.js

@@ -0,0 +1,32 @@
+import * as dntShim from "./_dnt.shims.js";
+import fs from "node:fs";
+import { webDriver } from "./filesink.web.js";
+import { getFileSink as getBaseFileSink, } from "./sink.js";
+/**
+ * A Node.js-specific file sink driver.
+ */
+export const nodeDriver = {
+    openSync(path) {
+        return fs.openSync(path, "a");
+    },
+    writeSync: fs.writeSync,
+    flushSync: fs.fsyncSync,
+    closeSync: fs.closeSync,
+};
+/**
+ * Get a file sink.
+ *
+ * Note that this function is unavailable in the browser.
+ *
+ * @param path A path to the file to write to.
+ * @param options The options for the sink.
+ * @returns A sink that writes to the file.  The sink is also a disposable
+ *          object that closes the file when disposed.
+ */
+export function getFileSink(path, options = {}) {
+    if ("document" in dntShim.dntGlobalThis) {
+        return getBaseFileSink(path, { ...options, ...webDriver });
+    }
+    return getBaseFileSink(path, { ...options, ...nodeDriver });
+}
+// cSpell: ignore filesink

package/esm/filesink.web.js

@@ -0,0 +1,12 @@
+function notImplemented() {
+    throw new Error("File sink is not available in the browser.");
+}
+/**
+ * A browser-specific file sink driver.  All methods throw an error.
+ */
+export const webDriver = {
+    openSync: notImplemented,
+    writeSync: notImplemented,
+    flushSync: notImplemented,
+    closeSync: notImplemented,
+};

package/esm/mod.js

@@ -1,5 +1,7 @@
 export { ConfigError, configure, reset, } from "./config.js";
+export { getFileSink } from "./filesink.node.js";
 export { getLevelFilter, toFilter, } from "./filter.js";
 export { defaultConsoleFormatter, defaultTextFormatter, } from "./formatter.js";
 export { getLogger } from "./logger.js";
-export { getConsoleSink, getFileSink, getStreamSink, } from "./sink.js";
+export { getConsoleSink, getStreamSink, } from "./sink.js";
+// cSpell: ignore filesink

package/esm/sink.js

@@ -60,6 +60,7 @@ export function getConsoleSink(options = {}) {
 }
 /**
  * Get a platform-independent file sink.
+ *
  * @typeParam TFile The type of the file descriptor.
  * @param path A path to the file to write to.
  * @param options The options for the sink and the file driver.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/logtape",
-  "version": "0.1.0-dev.16+907496aa",
+  "version": "0.1.0-dev.17+5e7affa9",
   "description": "Simple logging library for Deno/Node.js/Bun/browsers",
   "keywords": [
     "logging",

package/script/filesink.node.js

@@ -0,0 +1,62 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFileSink = exports.nodeDriver = void 0;
+const dntShim = __importStar(require("./_dnt.shims.js"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const filesink_web_js_1 = require("./filesink.web.js");
+const sink_js_1 = require("./sink.js");
+/**
+ * A Node.js-specific file sink driver.
+ */
+exports.nodeDriver = {
+    openSync(path) {
+        return node_fs_1.default.openSync(path, "a");
+    },
+    writeSync: node_fs_1.default.writeSync,
+    flushSync: node_fs_1.default.fsyncSync,
+    closeSync: node_fs_1.default.closeSync,
+};
+/**
+ * Get a file sink.
+ *
+ * Note that this function is unavailable in the browser.
+ *
+ * @param path A path to the file to write to.
+ * @param options The options for the sink.
+ * @returns A sink that writes to the file.  The sink is also a disposable
+ *          object that closes the file when disposed.
+ */
+function getFileSink(path, options = {}) {
+    if ("document" in dntShim.dntGlobalThis) {
+        return (0, sink_js_1.getFileSink)(path, { ...options, ...filesink_web_js_1.webDriver });
+    }
+    return (0, sink_js_1.getFileSink)(path, { ...options, ...exports.nodeDriver });
+}
+exports.getFileSink = getFileSink;
+// cSpell: ignore filesink

package/script/filesink.web.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.webDriver = void 0;
+function notImplemented() {
+    throw new Error("File sink is not available in the browser.");
+}
+/**
+ * A browser-specific file sink driver.  All methods throw an error.
+ */
+exports.webDriver = {
+    openSync: notImplemented,
+    writeSync: notImplemented,
+    flushSync: notImplemented,
+    closeSync: notImplemented,
+};

package/script/mod.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStreamSink = exports.getFileSink = exports.getConsoleSink = exports.getLogger = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.toFilter = exports.getLevelFilter = exports.reset = exports.configure = exports.ConfigError = void 0;
+exports.getStreamSink = exports.getConsoleSink = exports.getLogger = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.toFilter = exports.getLevelFilter = exports.getFileSink = exports.reset = exports.configure = exports.ConfigError = void 0;
 var config_js_1 = require("./config.js");
 Object.defineProperty(exports, "ConfigError", { enumerable: true, get: function () { return config_js_1.ConfigError; } });
 Object.defineProperty(exports, "configure", { enumerable: true, get: function () { return config_js_1.configure; } });
 Object.defineProperty(exports, "reset", { enumerable: true, get: function () { return config_js_1.reset; } });
+var filesink_node_js_1 = require("./filesink.node.js");
+Object.defineProperty(exports, "getFileSink", { enumerable: true, get: function () { return filesink_node_js_1.getFileSink; } });
 var filter_js_1 = require("./filter.js");
 Object.defineProperty(exports, "getLevelFilter", { enumerable: true, get: function () { return filter_js_1.getLevelFilter; } });
 Object.defineProperty(exports, "toFilter", { enumerable: true, get: function () { return filter_js_1.toFilter; } });
@@ -15,5 +17,5 @@ var logger_js_1 = require("./logger.js");
 Object.defineProperty(exports, "getLogger", { enumerable: true, get: function () { return logger_js_1.getLogger; } });
 var sink_js_1 = require("./sink.js");
 Object.defineProperty(exports, "getConsoleSink", { enumerable: true, get: function () { return sink_js_1.getConsoleSink; } });
-Object.defineProperty(exports, "getFileSink", { enumerable: true, get: function () { return sink_js_1.getFileSink; } });
 Object.defineProperty(exports, "getStreamSink", { enumerable: true, get: function () { return sink_js_1.getStreamSink; } });
+// cSpell: ignore filesink

package/script/sink.js

@@ -65,6 +65,7 @@ function getConsoleSink(options = {}) {
 exports.getConsoleSink = getConsoleSink;
 /**
  * Get a platform-independent file sink.
+ *
  * @typeParam TFile The type of the file descriptor.
  * @param path A path to the file to write to.
  * @param options The options for the sink and the file driver.

package/types/filesink.node.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+import { type FileSinkDriver, type FileSinkOptions, type Sink } from "./sink.js";
+/**
+ * A Node.js-specific file sink driver.
+ */
+export declare const nodeDriver: FileSinkDriver<number>;
+/**
+ * Get a file sink.
+ *
+ * Note that this function is unavailable in the browser.
+ *
+ * @param path A path to the file to write to.
+ * @param options The options for the sink.
+ * @returns A sink that writes to the file.  The sink is also a disposable
+ *          object that closes the file when disposed.
+ */
+export declare function getFileSink(path: string, options?: FileSinkOptions): Sink & Disposable;
+//# sourceMappingURL=filesink.node.d.ts.map

package/types/filesink.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesink.node.d.ts","sourceRoot":"","sources":["../src/filesink.node.ts"],"names":[],"mappings":";AAGA,OAAO,EACL,KAAK,cAAc,EACnB,KAAK,eAAe,EAEpB,KAAK,IAAI,EACV,MAAM,WAAW,CAAC;AAEnB;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,cAAc,CAAC,MAAM,CAO7C,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,eAAoB,GAC5B,IAAI,GAAG,UAAU,CAKnB"}

package/types/filesink.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesink.test.d.ts","sourceRoot":"","sources":["../src/filesink.test.ts"],"names":[],"mappings":""}

package/types/filesink.web.d.ts

@@ -0,0 +1,6 @@
+import type { FileSinkDriver } from "./sink.js";
+/**
+ * A browser-specific file sink driver.  All methods throw an error.
+ */
+export declare const webDriver: FileSinkDriver<void>;
+//# sourceMappingURL=filesink.web.d.ts.map

package/types/filesink.web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesink.web.d.ts","sourceRoot":"","sources":["../src/filesink.web.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AAMhD;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,cAAc,CAAC,IAAI,CAK1C,CAAC"}

package/types/mod.d.ts

@@ -1,7 +1,8 @@
 export { type Config, ConfigError, configure, type LoggerConfig, reset, } from "./config.js";
+export { getFileSink } from "./filesink.node.js";
 export { type Filter, type FilterLike, getLevelFilter, toFilter, } from "./filter.js";
 export { type ConsoleFormatter, defaultConsoleFormatter, defaultTextFormatter, type TextFormatter, } from "./formatter.js";
 export { getLogger, type Logger } from "./logger.js";
 export type { LogLevel, LogRecord } from "./record.js";
-export { type ConsoleSinkOptions, type FileSinkDriver, type FileSinkOptions, getConsoleSink, getFileSink, getStreamSink, type Sink, type StreamSinkOptions, } from "./sink.js";
+export { type ConsoleSinkOptions, type FileSinkDriver, type FileSinkOptions, getConsoleSink, getStreamSink, type Sink, type StreamSinkOptions, } from "./sink.js";
 //# sourceMappingURL=mod.d.ts.map

package/types/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,cAAc,EACd,WAAW,EACX,aAAa,EACb,KAAK,IAAI,EACT,KAAK,iBAAiB,GACvB,MAAM,WAAW,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,cAAc,EACd,QAAQ,GACT,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,gBAAgB,EACrB,uBAAuB,EACvB,oBAAoB,EACpB,KAAK,aAAa,GACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,SAAS,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AACrD,YAAY,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EACL,KAAK,kBAAkB,EACvB,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,cAAc,EACd,aAAa,EACb,KAAK,IAAI,EACT,KAAK,iBAAiB,GACvB,MAAM,WAAW,CAAC"}

package/types/sink.d.ts

@@ -107,6 +107,7 @@ export interface FileSinkDriver<TFile> {
 }
 /**
  * Get a platform-independent file sink.
+ *
  * @typeParam TFile The type of the file descriptor.
  * @param path A path to the file to write to.
  * @param options The options for the sink and the file driver.

package/types/sink.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sink.d.ts","sourceRoot":"","sources":["../src/sink.ts"],"names":[],"mappings":";;;AAAA,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EACL,KAAK,gBAAgB,EAGrB,KAAK,aAAa,EACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;GAQG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAC;CAChD;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,OAAO,CAAC,cAAc,EAC9B,OAAO,GAAE,iBAAsB,GAC9B,IAAI,GAAG,UAAU,CAUnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,GAAE,kBAAuB,GAAG,IAAI,CAYrE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK;IACnC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;CAC5B;AAED;;;;;;;GAOG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAC/B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,GAC/C,IAAI,GAAG,UAAU,CAUnB"}
+{"version":3,"file":"sink.d.ts","sourceRoot":"","sources":["../src/sink.ts"],"names":[],"mappings":";;;AAAA,OAAO,KAAK,OAAO,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EACL,KAAK,gBAAgB,EAGrB,KAAK,aAAa,EACnB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;;;;;;;GAQG;AACH,MAAM,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,SAAS,KAAK,IAAI,CAAC;AAE/C;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,SAAS,CAAC,EAAE,aAAa,CAAC;IAE1B;;OAEG;IACH,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,CAAC;CAChD;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,OAAO,CAAC,cAAc,EAC9B,OAAO,GAAE,iBAAsB,GAC9B,IAAI,GAAG,UAAU,CAUnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,SAAS,CAAC,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,OAAO,GAAE,kBAAuB,GAAG,IAAI,CAYrE;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC;AAEhD;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,KAAK;IACnC;;;OAGG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IAE9B;;;;OAIG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI,CAAC;IAE9C;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;IAE3B;;;OAGG;IACH,SAAS,CAAC,EAAE,EAAE,KAAK,GAAG,IAAI,CAAC;CAC5B;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAC/B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,GAC/C,IAAI,GAAG,UAAU,CAUnB"}