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

package/README.md

@@ -301,43 +301,90 @@ See also [`getFileSink()`] function, [`FileSinkOptions`] interface, and
 [`FileSinkOptions`]: https://jsr.io/@logtape/logtape/doc/~/FileSinkOptions
 [`FileSinkDriver`]: https://jsr.io/@logtape/logtape/doc/~/FileSinkDriver
 
-### Buffer sink
+### Text formatter
 
-For testing purposes, you may want to collect log messages in memory.  Although
-LogTape does not provide a built-in buffer sink, you can easily implement it:
+A stream sink and a file sink write log messages in a plain text format.
+You can customize the format by providing a text formatter.  The type of a
+text formatter is:
 
 ~~~~ typescript
-import { type LogRecord, configure } from "@logtape/logtape";
+export type TextFormatter = (record: LogRecord) => string;
+~~~~
 
-const buffer: LogRecord[] = [];
+Here's an example of a text formatter that writes log messages in a JSON format:
 
+~~~~ typescript
 configure({
   sinks: {
-    buffer: buffer.push.bind(buffer),
+    stream: getStreamSink(Deno.stderr.writable, {
+      formatter: JSON.stringify,
+    }),
   },
   // Omitted for brevity
-});
+})
 ~~~~
 
-### Text formatter
+### Disposable sink
 
-A stream sink and a file sink write log messages in a plain text format.
-You can customize the format by providing a text formatter.  The type of a
-text formatter is:
+A disposable sink is a sink that can be disposed of.  They are automatically
+disposed of when the configuration is reset or the program exits.  The type
+of a disposable sink is: `Sink & Disposable`.  You can create a disposable
+sink by defining a `[Symbol.dispose]` method:
 
 ~~~~ typescript
-export type TextFormatter = (record: LogRecord) => string;
+const disposableSink: Sink & Disposable = (record: LogRecord) => {
+  console.log(record.message);
+};
+disposableSink[Symbol.dispose] = () => {
+  console.log("Disposed!");
+};
 ~~~~
 
-Here's an example of a text formatter that writes log messages in a JSON format:
+
+Testing
+-------
+
+Here are some tips for testing your application or library with LogTape.
+
+### Reset configuration
+
+You can reset the configuration of LogTape to its initial state.  This is
+useful when you want to reset the configuration between tests.  For example,
+the following code shows how to reset the configuration after a test
+(regardless of whether the test passes or fails) in Deno:
+
+~~~~ typescript
+import { configure, reset } from "@logtape/logtape";
+
+Deno.test("my test", async (t) => {
+  await t.step("set up", () => {
+    configure({ /* ... */ });
+  });
+
+  await t.step("run test", () => {
+    // Run the test
+  });
+
+  await t.step("tear down", () => {
+    reset();
+  });
+});
+~~~~
+
+### Buffer sink
+
+For testing purposes, you may want to collect log messages in memory.  Although
+LogTape does not provide a built-in buffer sink, you can easily implement it:
 
 ~~~~ typescript
+import { type LogRecord, configure } from "@logtape/logtape";
+
+const buffer: LogRecord[] = [];
+
 configure({
   sinks: {
-    stream: getStreamSink(Deno.stderr.writable, {
-      formatter: JSON.stringify,
-    }),
+    buffer: buffer.push.bind(buffer),
   },
   // Omitted for brevity
-})
+});
 ~~~~

package/esm/config.js

@@ -1,10 +1,21 @@
+import * as dntShim from "./_dnt.shims.js";
 import { toFilter } from "./filter.js";
 import { LoggerImpl } from "./logger.js";
 import { getConsoleSink } from "./sink.js";
+/**
+ * Whether the loggers are configured.
+ */
 let configured = false;
+/**
+ * Disposables to dispose when resetting the configuration.
+ */
+const disposables = new Set();
 /**
  * Configure the loggers with the specified configuration.
  *
+ * Note that if the given sinks or filters are disposable, they will be
+ * disposed when the configuration is reset, or when the process exits.
+ *
  * @example
  * ```typescript
  * configure({
@@ -42,8 +53,8 @@ export function configure(config) {
     if (configured && !config.reset) {
         throw new ConfigError("Already configured; if you want to reset, turn on the reset flag.");
     }
+    reset();
     configured = true;
-    LoggerImpl.getLogger([]).resetDescendants();
     let metaConfigured = false;
     for (const cfg of config.loggers) {
         if (cfg.category.length === 0 ||
@@ -73,6 +84,20 @@ export function configure(config) {
             logger.filters.push(toFilter(filter));
         }
     }
+    for (const sink of Object.values(config.sinks)) {
+        if (Symbol.dispose in sink)
+            disposables.add(sink);
+    }
+    for (const filter of Object.values(config.filters)) {
+        if (filter != null && typeof filter !== "string" && Symbol.dispose in filter)
+            disposables.add(filter);
+    }
+    if ("process" in dntShim.dntGlobalThis) { // @ts-ignore: It's fine to use process in Node
+        process.on("exit", dispose);
+    }
+    else { // @ts-ignore: It's fine to addEventListener() on the browser/Deno
+        addEventListener("unload", dispose);
+    }
     const meta = LoggerImpl.getLogger(["logtape", "meta"]);
     if (!metaConfigured) {
         meta.sinks.push(getConsoleSink());
@@ -90,9 +115,18 @@ export function configure(config) {
  * Reset the configuration.  Mostly for testing purposes.
  */
 export function reset() {
+    dispose();
     LoggerImpl.getLogger([]).resetDescendants();
     configured = false;
 }
+/**
+ * Dispose of the disposables.
+ */
+export function dispose() {
+    for (const disposable of disposables)
+        disposable[Symbol.dispose]();
+    disposables.clear();
+}
 /**
  * A configuration error.
  */

package/esm/mod.js

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

package/esm/sink.js

@@ -27,10 +27,12 @@ export function getStreamSink(stream, options = {}) {
     const formatter = options.formatter ?? defaultTextFormatter;
     const encoder = options.encoder ?? new TextEncoder();
     const writer = stream.getWriter();
-    return (record) => {
+    const sink = (record) => {
         const bytes = encoder.encode(formatter(record));
         writer.ready.then(() => writer.write(bytes));
     };
+    sink[Symbol.dispose] = () => writer.close();
+    return sink;
 }
 /**
  * A console sink factory that returns a sink that logs to the console.
@@ -61,7 +63,8 @@ export function getConsoleSink(options = {}) {
  * @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.
- * @returns A sink that writes to the file.
+ * @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) {
     const formatter = options.formatter ?? defaultTextFormatter;
@@ -71,6 +74,6 @@ export function getFileSink(path, options) {
         options.writeSync(fd, encoder.encode(formatter(record)));
         options.flushSync(fd);
     };
-    sink.close = () => options.closeSync(fd);
+    sink[Symbol.dispose] = () => options.closeSync(fd);
     return sink;
 }

package/package.json

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

package/script/config.js

@@ -1,13 +1,47 @@
 "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;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigError = exports.reset = exports.configure = void 0;
+exports.ConfigError = exports.dispose = exports.reset = exports.configure = void 0;
+const dntShim = __importStar(require("./_dnt.shims.js"));
 const filter_js_1 = require("./filter.js");
 const logger_js_1 = require("./logger.js");
 const sink_js_1 = require("./sink.js");
+/**
+ * Whether the loggers are configured.
+ */
 let configured = false;
+/**
+ * Disposables to dispose when resetting the configuration.
+ */
+const disposables = new Set();
 /**
  * Configure the loggers with the specified configuration.
  *
+ * Note that if the given sinks or filters are disposable, they will be
+ * disposed when the configuration is reset, or when the process exits.
+ *
  * @example
  * ```typescript
  * configure({
@@ -45,8 +79,8 @@ function configure(config) {
     if (configured && !config.reset) {
         throw new ConfigError("Already configured; if you want to reset, turn on the reset flag.");
     }
+    reset();
     configured = true;
-    logger_js_1.LoggerImpl.getLogger([]).resetDescendants();
     let metaConfigured = false;
     for (const cfg of config.loggers) {
         if (cfg.category.length === 0 ||
@@ -76,6 +110,20 @@ function configure(config) {
             logger.filters.push((0, filter_js_1.toFilter)(filter));
         }
     }
+    for (const sink of Object.values(config.sinks)) {
+        if (Symbol.dispose in sink)
+            disposables.add(sink);
+    }
+    for (const filter of Object.values(config.filters)) {
+        if (filter != null && typeof filter !== "string" && Symbol.dispose in filter)
+            disposables.add(filter);
+    }
+    if ("process" in dntShim.dntGlobalThis) { // @ts-ignore: It's fine to use process in Node
+        process.on("exit", dispose);
+    }
+    else { // @ts-ignore: It's fine to addEventListener() on the browser/Deno
+        addEventListener("unload", dispose);
+    }
     const meta = logger_js_1.LoggerImpl.getLogger(["logtape", "meta"]);
     if (!metaConfigured) {
         meta.sinks.push((0, sink_js_1.getConsoleSink)());
@@ -94,10 +142,20 @@ exports.configure = configure;
  * Reset the configuration.  Mostly for testing purposes.
  */
 function reset() {
+    dispose();
     logger_js_1.LoggerImpl.getLogger([]).resetDescendants();
     configured = false;
 }
 exports.reset = reset;
+/**
+ * Dispose of the disposables.
+ */
+function dispose() {
+    for (const disposable of disposables)
+        disposable[Symbol.dispose]();
+    disposables.clear();
+}
+exports.dispose = dispose;
 /**
  * A configuration error.
  */

package/script/mod.js

@@ -1,15 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getConsoleSink = exports.getLogger = exports.defaultConsoleFormatter = exports.toFilter = exports.getLevelFilter = exports.configure = exports.ConfigError = void 0;
+exports.getStreamSink = exports.getFileSink = exports.getConsoleSink = exports.getLogger = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.toFilter = exports.getLevelFilter = 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 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; } });
 var formatter_js_1 = require("./formatter.js");
 Object.defineProperty(exports, "defaultConsoleFormatter", { enumerable: true, get: function () { return formatter_js_1.defaultConsoleFormatter; } });
+Object.defineProperty(exports, "defaultTextFormatter", { enumerable: true, get: function () { return formatter_js_1.defaultTextFormatter; } });
 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; } });

package/script/sink.js

@@ -30,10 +30,12 @@ function getStreamSink(stream, options = {}) {
     const formatter = options.formatter ?? formatter_js_1.defaultTextFormatter;
     const encoder = options.encoder ?? new TextEncoder();
     const writer = stream.getWriter();
-    return (record) => {
+    const sink = (record) => {
         const bytes = encoder.encode(formatter(record));
         writer.ready.then(() => writer.write(bytes));
     };
+    sink[Symbol.dispose] = () => writer.close();
+    return sink;
 }
 exports.getStreamSink = getStreamSink;
 /**
@@ -66,7 +68,8 @@ exports.getConsoleSink = getConsoleSink;
  * @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.
- * @returns A sink that writes to the file.
+ * @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) {
     const formatter = options.formatter ?? formatter_js_1.defaultTextFormatter;
@@ -76,7 +79,7 @@ function getFileSink(path, options) {
         options.writeSync(fd, encoder.encode(formatter(record)));
         options.flushSync(fd);
     };
-    sink.close = () => options.closeSync(fd);
+    sink[Symbol.dispose] = () => options.closeSync(fd);
     return sink;
 }
 exports.getFileSink = getFileSink;

package/types/config.d.ts

@@ -50,6 +50,9 @@ export interface LoggerConfig<TSinkId extends string, TFilterId extends string>
 /**
  * Configure the loggers with the specified configuration.
  *
+ * Note that if the given sinks or filters are disposable, they will be
+ * disposed when the configuration is reset, or when the process exits.
+ *
  * @example
  * ```typescript
  * configure({
@@ -88,6 +91,10 @@ export declare function configure<TSinkId extends string, TFilterId extends stri
  * Reset the configuration.  Mostly for testing purposes.
  */
 export declare function reset(): void;
+/**
+ * Dispose of the disposables.
+ */
+export declare function dispose(): void;
 /**
  * A configuration error.
  */

package/types/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAY,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAkB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACtE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAC3B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM;IAExB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CACzB;AAID;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,SAAS,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,EACxE,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,QA0DnC;AAED;;GAEG;AACH,wBAAgB,KAAK,SAGpB;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC;;;OAGG;gBACS,OAAO,EAAE,MAAM;CAI5B"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,UAAU,EAAY,MAAM,aAAa,CAAC;AAExD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAkB,KAAK,IAAI,EAAE,MAAM,WAAW,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM;IACtE;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;IAC7B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAEvC;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,CAAC;IAE5C;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY,CAC3B,OAAO,SAAS,MAAM,EACtB,SAAS,SAAS,MAAM;IAExB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,EAAE,CAAC;IAEtB;;;OAGG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;CACzB;AAYD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,SAAS,CAAC,OAAO,SAAS,MAAM,EAAE,SAAS,SAAS,MAAM,EACxE,MAAM,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,QA0EnC;AAED;;GAEG;AACH,wBAAgB,KAAK,SAIpB;AAED;;GAEG;AACH,wBAAgB,OAAO,SAGtB;AAED;;GAEG;AACH,qBAAa,WAAY,SAAQ,KAAK;IACpC;;;OAGG;gBACS,OAAO,EAAE,MAAM;CAI5B"}

package/types/mod.d.ts

@@ -1,7 +1,7 @@
-export { type Config, ConfigError, configure, type LoggerConfig, } from "./config.js";
+export { type Config, ConfigError, configure, type LoggerConfig, reset, } from "./config.js";
 export { type Filter, type FilterLike, getLevelFilter, toFilter, } from "./filter.js";
-export { type ConsoleFormatter, defaultConsoleFormatter, type TextFormatter, } from "./formatter.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 { getConsoleSink, type Sink } from "./sink.js";
+export { type ConsoleSinkOptions, type FileSinkDriver, type FileSinkOptions, getConsoleSink, getFileSink, 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,GAClB,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,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,EAAE,cAAc,EAAE,KAAK,IAAI,EAAE,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,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"}

package/types/sink.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import * as dntShim from "./_dnt.shims.js";
 import { type ConsoleFormatter, type TextFormatter } from "./formatter.js";
 import type { LogRecord } from "./record.js";
@@ -52,7 +53,7 @@ export interface StreamSinkOptions {
  * @param options The options for the sink.
  * @returns A sink that writes to the stream.
  */
-export declare function getStreamSink(stream: dntShim.WritableStream, options?: StreamSinkOptions): Sink;
+export declare function getStreamSink(stream: dntShim.WritableStream, options?: StreamSinkOptions): Sink & Disposable;
 /**
  * Options for the {@link getConsoleSink} function.
  */
@@ -109,9 +110,8 @@ export interface FileSinkDriver<TFile> {
  * @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.
- * @returns A sink that writes to the file.
+ * @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<TFile>(path: string, options: FileSinkOptions & FileSinkDriver<TFile>): Sink & {
-    close: () => void;
-};
+export declare function getFileSink<TFile>(path: string, options: FileSinkOptions & FileSinkDriver<TFile>): Sink & Disposable;
 //# sourceMappingURL=sink.d.ts.map

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,CAQN;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;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAC/B,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,eAAe,GAAG,cAAc,CAAC,KAAK,CAAC,GAC/C,IAAI,GAAG;IAAE,KAAK,EAAE,MAAM,IAAI,CAAA;CAAE,CAU9B"}
+{"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"}