@logtape/file 0.11.0-dev.175 → 0.12.0-dev.181

package/dist/filesink.node.cjs

@@ -0,0 +1,60 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const require_filesink_base = require('./filesink.base.cjs');
+const node_fs = require_rolldown_runtime.__toESM(require("node:fs"));
+
+//#region filesink.node.ts
+/**
+* A Node.js-specific file sink driver.
+*/
+const nodeDriver = {
+	openSync(path) {
+		return node_fs.default.openSync(path, "a");
+	},
+	writeSync: node_fs.default.writeSync,
+	flushSync: node_fs.default.fsyncSync,
+	closeSync: node_fs.default.closeSync,
+	statSync: node_fs.default.statSync,
+	renameSync: node_fs.default.renameSync
+};
+/**
+* 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 = {}) {
+	return require_filesink_base.getBaseFileSink(path, {
+		...options,
+		...nodeDriver
+	});
+}
+/**
+* Get a rotating file sink.
+*
+* This sink writes log records to a file, and rotates the file when it reaches
+* the `maxSize`.  The rotated files are named with the original file name
+* followed by a dot and a number, starting from 1.  The number is incremented
+* for each rotation, and the maximum number of files to keep is `maxFiles`.
+*
+* 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 and the file driver.
+* @returns A sink that writes to the file.  The sink is also a disposable
+*          object that closes the file when disposed.
+*/
+function getRotatingFileSink(path, options = {}) {
+	return require_filesink_base.getBaseRotatingFileSink(path, {
+		...options,
+		...nodeDriver
+	});
+}
+
+//#endregion
+exports.getFileSink = getFileSink;
+exports.getRotatingFileSink = getRotatingFileSink;
+exports.nodeDriver = nodeDriver;

package/{esm/file/filesink.node.js → dist/filesink.node.d.cts}

@@ -1,18 +1,12 @@
-import fs from "node:fs";
-import { getBaseFileSink, getBaseRotatingFileSink, } from "./filesink.base.js";
+import { FileSinkOptions, RotatingFileSinkDriver, RotatingFileSinkOptions } from "./filesink.base.cjs";
+import { Sink } from "@logtape/logtape";
+
+//#region filesink.node.d.ts
+
 /**
  * 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,
-    statSync: fs.statSync,
-    renameSync: fs.renameSync,
-};
+declare const nodeDriver: RotatingFileSinkDriver<number | void>;
 /**
  * Get a file sink.
  *
@@ -23,9 +17,7 @@ export const nodeDriver = {
  * @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 = {}) {
-    return getBaseFileSink(path, { ...options, ...nodeDriver });
-}
+declare function getFileSink(path: string, options?: FileSinkOptions): Sink & Disposable;
 /**
  * Get a rotating file sink.
  *
@@ -41,7 +33,8 @@ export function getFileSink(path, options = {}) {
  * @returns A sink that writes to the file.  The sink is also a disposable
  *          object that closes the file when disposed.
  */
-export function getRotatingFileSink(path, options = {}) {
-    return getBaseRotatingFileSink(path, { ...options, ...nodeDriver });
-}
-// cSpell: ignore filesink
+declare function getRotatingFileSink(path: string, options?: RotatingFileSinkOptions): Sink & Disposable;
+//# sourceMappingURL=filesink.node.d.ts.map
+//#endregion
+export { getFileSink, getRotatingFileSink, nodeDriver };
+//# sourceMappingURL=filesink.node.d.cts.map

package/dist/filesink.node.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesink.node.d.cts","names":[],"sources":["../filesink.node.ts"],"sourcesContent":[],"mappings":";;;;;;;AAaA;AAqBgB,cArBH,UAqBc,EArBF,sBAqBE,CAAA,MAAA,GAAA,IAAA,CAAA;;;;;AAGP;AAmBpB;;;;;AAGoB,iBAzBJ,WAAA,CAyBI,IAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAvBT,eAuBS,CAAA,EAtBjB,IAsBiB,GAtBV,UAsBU;;;;;;;;;;;;;;;;iBAHJ,mBAAA,yBAEL,0BACR,OAAO"}

package/{types/file → dist}/filesink.node.d.ts

@@ -1,9 +1,12 @@
-import type { Sink } from "@logtape/logtape";
-import { type FileSinkOptions, type RotatingFileSinkDriver, type RotatingFileSinkOptions } from "./filesink.base.js";
+import { FileSinkOptions, RotatingFileSinkDriver, RotatingFileSinkOptions } from "./filesink.base.js";
+import { Sink } from "@logtape/logtape";
+
+//#region filesink.node.d.ts
+
 /**
  * A Node.js-specific file sink driver.
  */
-export declare const nodeDriver: RotatingFileSinkDriver<number | void>;
+declare const nodeDriver: RotatingFileSinkDriver<number | void>;
 /**
  * Get a file sink.
  *
@@ -14,7 +17,7 @@ export declare const nodeDriver: RotatingFileSinkDriver<number | void>;
  * @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;
+declare function getFileSink(path: string, options?: FileSinkOptions): Sink & Disposable;
 /**
  * Get a rotating file sink.
  *
@@ -30,5 +33,8 @@ export declare function getFileSink(path: string, options?: FileSinkOptions): Si
  * @returns A sink that writes to the file.  The sink is also a disposable
  *          object that closes the file when disposed.
  */
-export declare function getRotatingFileSink(path: string, options?: RotatingFileSinkOptions): Sink & Disposable;
+declare function getRotatingFileSink(path: string, options?: RotatingFileSinkOptions): Sink & Disposable;
+//# sourceMappingURL=filesink.node.d.ts.map
+//#endregion
+export { getFileSink, getRotatingFileSink, nodeDriver };
 //# sourceMappingURL=filesink.node.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"filesink.node.d.ts","names":[],"sources":["../filesink.node.ts"],"sourcesContent":[],"mappings":";;;;;;;AAaA;AAqBgB,cArBH,UAqBc,EArBF,sBAqBE,CAAA,MAAA,GAAA,IAAA,CAAA;;;;;AAGP;AAmBpB;;;;;AAGoB,iBAzBJ,WAAA,CAyBI,IAAA,EAAA,MAAA,EAAA,OAAA,CAAA,EAvBT,eAuBS,CAAA,EAtBjB,IAsBiB,GAtBV,UAsBU;;;;;;;;;;;;;;;;iBAHJ,mBAAA,yBAEL,0BACR,OAAO"}

package/dist/filesink.node.js

@@ -0,0 +1,58 @@
+import { getBaseFileSink, getBaseRotatingFileSink } from "./filesink.base.js";
+import fs from "node:fs";
+
+//#region filesink.node.ts
+/**
+* A Node.js-specific file sink driver.
+*/
+const nodeDriver = {
+	openSync(path) {
+		return fs.openSync(path, "a");
+	},
+	writeSync: fs.writeSync,
+	flushSync: fs.fsyncSync,
+	closeSync: fs.closeSync,
+	statSync: fs.statSync,
+	renameSync: fs.renameSync
+};
+/**
+* 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 = {}) {
+	return getBaseFileSink(path, {
+		...options,
+		...nodeDriver
+	});
+}
+/**
+* Get a rotating file sink.
+*
+* This sink writes log records to a file, and rotates the file when it reaches
+* the `maxSize`.  The rotated files are named with the original file name
+* followed by a dot and a number, starting from 1.  The number is incremented
+* for each rotation, and the maximum number of files to keep is `maxFiles`.
+*
+* 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 and the file driver.
+* @returns A sink that writes to the file.  The sink is also a disposable
+*          object that closes the file when disposed.
+*/
+function getRotatingFileSink(path, options = {}) {
+	return getBaseRotatingFileSink(path, {
+		...options,
+		...nodeDriver
+	});
+}
+
+//#endregion
+export { getFileSink, getRotatingFileSink, nodeDriver };
+//# sourceMappingURL=filesink.node.js.map

package/dist/filesink.node.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesink.node.js","names":["nodeDriver: RotatingFileSinkDriver<number | void>","path: string","options: FileSinkOptions","options: RotatingFileSinkOptions"],"sources":["../filesink.node.ts"],"sourcesContent":["import type { Sink } from \"@logtape/logtape\";\nimport fs from \"node:fs\";\nimport {\n  type FileSinkOptions,\n  getBaseFileSink,\n  getBaseRotatingFileSink,\n  type RotatingFileSinkDriver,\n  type RotatingFileSinkOptions,\n} from \"./filesink.base.ts\";\n\n/**\n * A Node.js-specific file sink driver.\n */\nexport const nodeDriver: RotatingFileSinkDriver<number | void> = {\n  openSync(path: string) {\n    return fs.openSync(path, \"a\");\n  },\n  writeSync: fs.writeSync,\n  flushSync: fs.fsyncSync,\n  closeSync: fs.closeSync,\n  statSync: fs.statSync,\n  renameSync: fs.renameSync,\n};\n\n/**\n * Get a file sink.\n *\n * Note that this function is unavailable in the browser.\n *\n * @param path A path to the file to write to.\n * @param options The options for the sink.\n * @returns A sink that writes to the file.  The sink is also a disposable\n *          object that closes the file when disposed.\n */\nexport function getFileSink(\n  path: string,\n  options: FileSinkOptions = {},\n): Sink & Disposable {\n  return getBaseFileSink(path, { ...options, ...nodeDriver });\n}\n\n/**\n * Get a rotating file sink.\n *\n * This sink writes log records to a file, and rotates the file when it reaches\n * the `maxSize`.  The rotated files are named with the original file name\n * followed by a dot and a number, starting from 1.  The number is incremented\n * for each rotation, and the maximum number of files to keep is `maxFiles`.\n *\n * Note that this function is unavailable in the browser.\n *\n * @param path A path to the file to write to.\n * @param options The options for the sink and the file driver.\n * @returns A sink that writes to the file.  The sink is also a disposable\n *          object that closes the file when disposed.\n */\nexport function getRotatingFileSink(\n  path: string,\n  options: RotatingFileSinkOptions = {},\n): Sink & Disposable {\n  return getBaseRotatingFileSink(path, { ...options, ...nodeDriver });\n}\n\n// cSpell: ignore filesink\n"],"mappings":";;;;;;;AAaA,MAAaA,aAAoD;CAC/D,SAASC,MAAc;AACrB,SAAO,GAAG,SAAS,MAAM,IAAI;CAC9B;CACD,WAAW,GAAG;CACd,WAAW,GAAG;CACd,WAAW,GAAG;CACd,UAAU,GAAG;CACb,YAAY,GAAG;AAChB;;;;;;;;;;;AAYD,SAAgB,YACdA,MACAC,UAA2B,CAAE,GACV;AACnB,QAAO,gBAAgB,MAAM;EAAE,GAAG;EAAS,GAAG;CAAY,EAAC;AAC5D;;;;;;;;;;;;;;;;AAiBD,SAAgB,oBACdD,MACAE,UAAmC,CAAE,GAClB;AACnB,QAAO,wBAAwB,MAAM;EAAE,GAAG;EAAS,GAAG;CAAY,EAAC;AACpE"}

package/dist/mod.cjs

@@ -0,0 +1,15 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const __filesink = require_rolldown_runtime.__toESM(require("#filesink"));
+
+Object.defineProperty(exports, 'getFileSink', {
+  enumerable: true,
+  get: function () {
+    return __filesink.getFileSink;
+  }
+});
+Object.defineProperty(exports, 'getRotatingFileSink', {
+  enumerable: true,
+  get: function () {
+    return __filesink.getRotatingFileSink;
+  }
+});

package/dist/mod.d.cts

@@ -0,0 +1,3 @@
+import { FileSinkDriver, FileSinkOptions, RotatingFileSinkDriver, RotatingFileSinkOptions } from "./filesink.base.cjs";
+import { getFileSink, getRotatingFileSink } from "#filesink";
+export { FileSinkDriver, FileSinkOptions, RotatingFileSinkDriver, RotatingFileSinkOptions, getFileSink, getRotatingFileSink };

package/dist/mod.d.ts

@@ -0,0 +1,3 @@
+import { FileSinkDriver, FileSinkOptions, RotatingFileSinkDriver, RotatingFileSinkOptions } from "./filesink.base.js";
+import { getFileSink, getRotatingFileSink } from "#filesink";
+export { FileSinkDriver, FileSinkOptions, RotatingFileSinkDriver, RotatingFileSinkOptions, getFileSink, getRotatingFileSink };

package/dist/mod.js

@@ -0,0 +1,3 @@
+import { getFileSink, getRotatingFileSink } from "#filesink";
+
+export { getFileSink, getRotatingFileSink };

package/filesink.base.ts

@@ -0,0 +1,170 @@
+import {
+  defaultTextFormatter,
+  type LogRecord,
+  type Sink,
+  type StreamSinkOptions,
+} from "@logtape/logtape";
+
+/**
+ * Options for the {@link getBaseFileSink} function.
+ */
+export type FileSinkOptions = StreamSinkOptions & {
+  /**
+   * If `true`, the file is not opened until the first write.  Defaults to `false`.
+   */
+  lazy?: boolean;
+};
+
+/**
+ * A platform-specific file sink driver.
+ * @typeParam TFile The type of the file descriptor.
+ */
+export interface FileSinkDriver<TFile> {
+  /**
+   * Open a file for appending and return a file descriptor.
+   * @param path A path to the file to open.
+   */
+  openSync(path: string): TFile;
+
+  /**
+   * Write a chunk of data to the file.
+   * @param fd The file descriptor.
+   * @param chunk The data to write.
+   */
+  writeSync(fd: TFile, chunk: Uint8Array): void;
+
+  /**
+   * Flush the file to ensure that all data is written to the disk.
+   * @param fd The file descriptor.
+   */
+  flushSync(fd: TFile): void;
+
+  /**
+   * Close the file.
+   * @param fd The file descriptor.
+   */
+  closeSync(fd: TFile): void;
+}
+
+/**
+ * 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.
+ * @returns A sink that writes to the file.  The sink is also a disposable
+ *          object that closes the file when disposed.
+ */
+export function getBaseFileSink<TFile>(
+  path: string,
+  options: FileSinkOptions & FileSinkDriver<TFile>,
+): Sink & Disposable {
+  const formatter = options.formatter ?? defaultTextFormatter;
+  const encoder = options.encoder ?? new TextEncoder();
+  let fd = options.lazy ? null : options.openSync(path);
+  const sink: Sink & Disposable = (record: LogRecord) => {
+    if (fd === null) {
+      fd = options.openSync(path);
+    }
+    options.writeSync(fd, encoder.encode(formatter(record)));
+    options.flushSync(fd);
+  };
+  sink[Symbol.dispose] = () => {
+    if (fd !== null) {
+      options.closeSync(fd);
+    }
+  };
+  return sink;
+}
+
+/**
+ * Options for the {@link getBaseRotatingFileSink} function.
+ */
+export interface RotatingFileSinkOptions extends Omit<FileSinkOptions, "lazy"> {
+  /**
+   * The maximum bytes of the file before it is rotated.  1 MiB by default.
+   */
+  maxSize?: number;
+
+  /**
+   * The maximum number of files to keep.  5 by default.
+   */
+  maxFiles?: number;
+}
+
+/**
+ * A platform-specific rotating file sink driver.
+ */
+export interface RotatingFileSinkDriver<TFile> extends FileSinkDriver<TFile> {
+  /**
+   * Get the size of the file.
+   * @param path A path to the file.
+   * @returns The `size` of the file in bytes, in an object.
+   */
+  statSync(path: string): { size: number };
+
+  /**
+   * Rename a file.
+   * @param oldPath A path to the file to rename.
+   * @param newPath A path to be renamed to.
+   */
+  renameSync(oldPath: string, newPath: string): void;
+}
+
+/**
+ * Get a platform-independent rotating file sink.
+ *
+ * This sink writes log records to a file, and rotates the file when it reaches
+ * the `maxSize`.  The rotated files are named with the original file name
+ * followed by a dot and a number, starting from 1.  The number is incremented
+ * for each rotation, and the maximum number of files to keep is `maxFiles`.
+ *
+ * @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.  The sink is also a disposable
+ *          object that closes the file when disposed.
+ */
+export function getBaseRotatingFileSink<TFile>(
+  path: string,
+  options: RotatingFileSinkOptions & RotatingFileSinkDriver<TFile>,
+): Sink & Disposable {
+  const formatter = options.formatter ?? defaultTextFormatter;
+  const encoder = options.encoder ?? new TextEncoder();
+  const maxSize = options.maxSize ?? 1024 * 1024;
+  const maxFiles = options.maxFiles ?? 5;
+  let offset: number = 0;
+  try {
+    const stat = options.statSync(path);
+    offset = stat.size;
+  } catch {
+    // Continue as the offset is already 0.
+  }
+  let fd = options.openSync(path);
+  function shouldRollover(bytes: Uint8Array): boolean {
+    return offset + bytes.length > maxSize;
+  }
+  function performRollover(): void {
+    options.closeSync(fd);
+    for (let i = maxFiles - 1; i > 0; i--) {
+      const oldPath = `${path}.${i}`;
+      const newPath = `${path}.${i + 1}`;
+      try {
+        options.renameSync(oldPath, newPath);
+      } catch (_) {
+        // Continue if the file does not exist.
+      }
+    }
+    options.renameSync(path, `${path}.1`);
+    offset = 0;
+    fd = options.openSync(path);
+  }
+  const sink: Sink & Disposable = (record: LogRecord) => {
+    const bytes = encoder.encode(formatter(record));
+    if (shouldRollover(bytes)) performRollover();
+    options.writeSync(fd, bytes);
+    options.flushSync(fd);
+    offset += bytes.length;
+  };
+  sink[Symbol.dispose] = () => options.closeSync(fd);
+  return sink;
+}

package/filesink.deno.ts

@@ -0,0 +1,69 @@
+import type { Sink } from "@logtape/logtape";
+import {
+  type FileSinkOptions,
+  getBaseFileSink,
+  getBaseRotatingFileSink,
+  type RotatingFileSinkDriver,
+  type RotatingFileSinkOptions,
+} from "./filesink.base.ts";
+
+/**
+ * A Deno-specific file sink driver.
+ */
+export const denoDriver: RotatingFileSinkDriver<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();
+  },
+  statSync: globalThis?.Deno.statSync,
+  renameSync: globalThis?.Deno.renameSync,
+};
+
+/**
+ * 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: string,
+  options: FileSinkOptions = {},
+): Sink & Disposable {
+  return getBaseFileSink(path, { ...options, ...denoDriver });
+}
+
+/**
+ * Get a rotating file sink.
+ *
+ * This sink writes log records to a file, and rotates the file when it reaches
+ * the `maxSize`.  The rotated files are named with the original file name
+ * followed by a dot and a number, starting from 1.  The number is incremented
+ * for each rotation, and the maximum number of files to keep is `maxFiles`.
+ *
+ * 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 and the file driver.
+ * @returns A sink that writes to the file.  The sink is also a disposable
+ *          object that closes the file when disposed.
+ */
+export function getRotatingFileSink(
+  path: string,
+  options: RotatingFileSinkOptions = {},
+): Sink & Disposable {
+  return getBaseRotatingFileSink(path, { ...options, ...denoDriver });
+}
+
+// cSpell: ignore filesink

package/filesink.jsr.ts

@@ -0,0 +1,52 @@
+import type { Sink } from "@logtape/logtape";
+import type {
+  FileSinkOptions,
+  RotatingFileSinkOptions,
+} from "./filesink.base.ts";
+
+const filesink: Omit<typeof import("./filesink.deno.ts"), "denoDriver"> =
+  // dnt-shim-ignore
+  await ("Deno" in globalThis
+    ? import("./filesink.deno.ts")
+    : import("./filesink.node.ts"));
+
+/**
+ * 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: string,
+  options: FileSinkOptions = {},
+): Sink & Disposable {
+  return filesink.getFileSink(path, options);
+}
+
+/**
+ * Get a rotating file sink.
+ *
+ * This sink writes log records to a file, and rotates the file when it reaches
+ * the `maxSize`.  The rotated files are named with the original file name
+ * followed by a dot and a number, starting from 1.  The number is incremented
+ * for each rotation, and the maximum number of files to keep is `maxFiles`.
+ *
+ * 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 and the file driver.
+ * @returns A sink that writes to the file.  The sink is also a disposable
+ *          object that closes the file when disposed.
+ */
+export function getRotatingFileSink(
+  path: string,
+  options: RotatingFileSinkOptions = {},
+): Sink & Disposable {
+  return filesink.getRotatingFileSink(path, options);
+}
+
+// cSpell: ignore filesink

package/filesink.node.ts

@@ -0,0 +1,64 @@
+import type { Sink } from "@logtape/logtape";
+import fs from "node:fs";
+import {
+  type FileSinkOptions,
+  getBaseFileSink,
+  getBaseRotatingFileSink,
+  type RotatingFileSinkDriver,
+  type RotatingFileSinkOptions,
+} from "./filesink.base.ts";
+
+/**
+ * A Node.js-specific file sink driver.
+ */
+export const nodeDriver: RotatingFileSinkDriver<number | void> = {
+  openSync(path: string) {
+    return fs.openSync(path, "a");
+  },
+  writeSync: fs.writeSync,
+  flushSync: fs.fsyncSync,
+  closeSync: fs.closeSync,
+  statSync: fs.statSync,
+  renameSync: fs.renameSync,
+};
+
+/**
+ * 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: string,
+  options: FileSinkOptions = {},
+): Sink & Disposable {
+  return getBaseFileSink(path, { ...options, ...nodeDriver });
+}
+
+/**
+ * Get a rotating file sink.
+ *
+ * This sink writes log records to a file, and rotates the file when it reaches
+ * the `maxSize`.  The rotated files are named with the original file name
+ * followed by a dot and a number, starting from 1.  The number is incremented
+ * for each rotation, and the maximum number of files to keep is `maxFiles`.
+ *
+ * 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 and the file driver.
+ * @returns A sink that writes to the file.  The sink is also a disposable
+ *          object that closes the file when disposed.
+ */
+export function getRotatingFileSink(
+  path: string,
+  options: RotatingFileSinkOptions = {},
+): Sink & Disposable {
+  return getBaseRotatingFileSink(path, { ...options, ...nodeDriver });
+}
+
+// cSpell: ignore filesink