@logtape/logtape 0.2.0-dev.20 → 0.2.0

package/README.md

@@ -12,17 +12,18 @@ LogTape
 > LogTape is still in the early stage of development.  The API is not stable
 > yet.  Please be careful when using it in production.
 
-LogTape is a simple logging library for Deno/Node.js/Bun/browsers.  It is
-designed to be used for both applications and libraries.
+LogTape is a simple logging library with zero dependencies for
+Deno/Node.js/Bun/browsers.  It is designed to be used for both applications
+and libraries.
 
-Currently, LogTape provides only few sinks, but you can easily add your own
-sinks.
+Currently, LogTape provides only few sinks, but [you can easily add your own
+sinks.](#sinks)
 
 ![](./screenshots/web-console.png)
 ![](./screenshots/terminal-console.png)
 
 [JSR]: https://jsr.io/@logtape/logtape
-[JSR badge]: https://jsr.io/badges/@logtape/logtape
+[JSR badge]: https://jsr.io/badges/@logtape/logtape?v=0.2.0
 [npm]: https://www.npmjs.com/package/@logtape/logtape
 [npm badge]: https://img.shields.io/npm/v/@logtape/logtape?logo=npm
 [GitHub Actions]: https://github.com/dahlia/logtape/actions/workflows/main.yaml
@@ -270,6 +271,37 @@ in the API reference for more details.
 [`getFileSink()`]: https://jsr.io/@logtape/logtape/doc/~/getFileSink
 [`FileSinkOptions`]: https://jsr.io/@logtape/logtape/doc/~/FileSinkOptions
 
+### Rotating file sink
+
+> [!NOTE]
+> File sink is unavailable in the browser environment.
+
+A rotating file sink is a file sink that rotates log files.  It creates a new
+log file when the current log file reaches a certain size.  Here's an example
+of a rotating file sink that writes log messages to a file:
+
+~~~~ typescript
+import { getRotatingFileSink } from "@logtape/logtape";
+
+await configure({
+  sinks: {
+    file: getRotatingFileSink("my-app.log", {
+      maxFileSize: 1024 * 1024,  // 1 MiB
+      maxFiles: 5,
+    }),
+  },
+  // Omitted for brevity
+});
+~~~~
+
+Rotated log files are named with a suffix like *.1*, *.2*, *.3*, and so on.
+
+For more details, see [`getRotatingFileSink()`] function and
+[`RotatingFileSinkOptions`] interface in the API reference.
+
+[`getRotatingFileSink()`]: https://jsr.io/@logtape/logtape/doc/~/getRotatingFileSink
+[`RotatingFileSinkOptions`]: https://jsr.io/@logtape/logtape/doc/~/RotatingFileSinkOptions
+
 ### Text formatter
 
 A stream sink and a file sink write log messages in a plain text format.
@@ -295,6 +327,10 @@ await configure({
 
 ### Disposable sink
 
+> [!TIP]
+> If you are unfamiliar with the concept of disposables, see also the proposal
+> of *[ECMAScript Explicit Resource Management]*.
+
 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
@@ -322,9 +358,11 @@ asyncDisposableSink[Symbol.asyncDispose] = async () => {
 };
 ~~~~
 
+[ECMAScript Explicit Resource Management]: https://github.com/tc39/proposal-explicit-resource-management
+
 ### Explicit disposal
 
-You can explicitly dispose of a sink by calling the `dispose()` method.  It is
+You can explicitly dispose of a sink by calling the [`dispose()`] method.  It is
 useful when you want to flush the buffer of a sink without blocking returning
 a response in edge functions.  Here's an example of using the `dispose()`
 with [`ctx.waitUntil()`] in Cloudflare Workers:
@@ -341,6 +379,7 @@ export default {
 }
 ~~~~
 
+[`dispose()`]: https://jsr.io/@logtape/logtape/doc/~/dispose
 [`ctx.waitUntil()`]: https://developers.cloudflare.com/workers/runtime-apis/context/#waituntil
 
 

package/esm/filesink.node.js

@@ -1,7 +1,7 @@
 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";
+import { getFileSink as getBaseFileSink, getRotatingFileSink as getBaseRotatingFileSink, } from "./sink.js";
 /**
  * A Node.js-specific file sink driver.
  */
@@ -12,6 +12,8 @@ export const nodeDriver = {
     writeSync: fs.writeSync,
     flushSync: fs.fsyncSync,
     closeSync: fs.closeSync,
+    statSync: fs.statSync,
+    renameSync: fs.renameSync,
 };
 /**
  * Get a file sink.
@@ -29,4 +31,25 @@ export 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.
+ */
+export function getRotatingFileSink(path, options = {}) {
+    if ("document" in dntShim.dntGlobalThis) {
+        return getBaseRotatingFileSink(path, { ...options, ...webDriver });
+    }
+    return getBaseRotatingFileSink(path, { ...options, ...nodeDriver });
+}
 // cSpell: ignore filesink

package/esm/filesink.web.js

@@ -9,4 +9,6 @@ export const webDriver = {
     writeSync: notImplemented,
     flushSync: notImplemented,
     closeSync: notImplemented,
+    statSync: notImplemented,
+    renameSync: notImplemented,
 };

package/esm/mod.js

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

package/esm/sink.js

@@ -84,3 +84,53 @@ export function getFileSink(path, options) {
     sink[Symbol.dispose] = () => options.closeSync(fd);
     return sink;
 }
+/**
+ * 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 getRotatingFileSink(path, options) {
+    const formatter = options.formatter ?? defaultTextFormatter;
+    const encoder = options.encoder ?? new TextEncoder();
+    const maxSize = options.maxSize ?? 1024 * 1024;
+    const maxFiles = options.maxFiles ?? 5;
+    let { size: offset } = options.statSync(path);
+    let fd = options.openSync(path);
+    function shouldRollover(bytes) {
+        return offset + bytes.length > maxSize;
+    }
+    function performRollover() {
+        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 = (record) => {
+        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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@logtape/logtape",
-  "version": "0.2.0-dev.20+cb7e4d9d",
-  "description": "Simple logging library for Deno/Node.js/Bun/browsers",
+  "version": "0.2.0",
+  "description": "Simple logging library with zero dependencies for Deno/Node.js/Bun/browsers",
   "keywords": [
     "logging",
     "log",

package/script/filesink.node.js

@@ -26,7 +26,7 @@ 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;
+exports.getRotatingFileSink = 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");
@@ -41,6 +41,8 @@ exports.nodeDriver = {
     writeSync: node_fs_1.default.writeSync,
     flushSync: node_fs_1.default.fsyncSync,
     closeSync: node_fs_1.default.closeSync,
+    statSync: node_fs_1.default.statSync,
+    renameSync: node_fs_1.default.renameSync,
 };
 /**
  * Get a file sink.
@@ -59,4 +61,26 @@ function getFileSink(path, options = {}) {
     return (0, sink_js_1.getFileSink)(path, { ...options, ...exports.nodeDriver });
 }
 exports.getFileSink = getFileSink;
+/**
+ * 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 = {}) {
+    if ("document" in dntShim.dntGlobalThis) {
+        return (0, sink_js_1.getRotatingFileSink)(path, { ...options, ...filesink_web_js_1.webDriver });
+    }
+    return (0, sink_js_1.getRotatingFileSink)(path, { ...options, ...exports.nodeDriver });
+}
+exports.getRotatingFileSink = getRotatingFileSink;
 // cSpell: ignore filesink

package/script/filesink.web.js

@@ -12,4 +12,6 @@ exports.webDriver = {
     writeSync: notImplemented,
     flushSync: notImplemented,
     closeSync: notImplemented,
+    statSync: notImplemented,
+    renameSync: notImplemented,
 };

package/script/mod.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getStreamSink = exports.getConsoleSink = exports.getLogger = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.toFilter = exports.getLevelFilter = exports.getFileSink = exports.reset = exports.dispose = exports.configure = exports.ConfigError = void 0;
+exports.getStreamSink = exports.getConsoleSink = exports.getLogger = exports.defaultTextFormatter = exports.defaultConsoleFormatter = exports.toFilter = exports.getLevelFilter = exports.getRotatingFileSink = exports.getFileSink = exports.reset = exports.dispose = 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; } });
@@ -8,6 +8,7 @@ Object.defineProperty(exports, "dispose", { enumerable: true, get: function () {
 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; } });
+Object.defineProperty(exports, "getRotatingFileSink", { enumerable: true, get: function () { return filesink_node_js_1.getRotatingFileSink; } });
 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; } });

package/script/sink.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFileSink = exports.getConsoleSink = exports.getStreamSink = void 0;
+exports.getRotatingFileSink = exports.getFileSink = exports.getConsoleSink = exports.getStreamSink = void 0;
 const formatter_js_1 = require("./formatter.js");
 /**
  * A factory that returns a sink that writes to a {@link WritableStream}.
@@ -90,3 +90,54 @@ function getFileSink(path, options) {
     return sink;
 }
 exports.getFileSink = getFileSink;
+/**
+ * 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.
+ */
+function getRotatingFileSink(path, options) {
+    const formatter = options.formatter ?? formatter_js_1.defaultTextFormatter;
+    const encoder = options.encoder ?? new TextEncoder();
+    const maxSize = options.maxSize ?? 1024 * 1024;
+    const maxFiles = options.maxFiles ?? 5;
+    let { size: offset } = options.statSync(path);
+    let fd = options.openSync(path);
+    function shouldRollover(bytes) {
+        return offset + bytes.length > maxSize;
+    }
+    function performRollover() {
+        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 = (record) => {
+        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;
+}
+exports.getRotatingFileSink = getRotatingFileSink;

package/types/filesink.node.d.ts

@@ -1,9 +1,9 @@
 /// <reference types="node" />
-import { type FileSinkDriver, type FileSinkOptions, type Sink } from "./sink.js";
+import { type FileSinkOptions, type RotatingFileSinkDriver, type RotatingFileSinkOptions, type Sink } from "./sink.js";
 /**
  * A Node.js-specific file sink driver.
  */
-export declare const nodeDriver: FileSinkDriver<number>;
+export declare const nodeDriver: RotatingFileSinkDriver<number>;
 /**
  * Get a file sink.
  *
@@ -15,4 +15,20 @@ export declare const nodeDriver: FileSinkDriver<number>;
  *          object that closes the file when disposed.
  */
 export declare function getFileSink(path: string, options?: FileSinkOptions): Sink & Disposable;
+/**
+ * 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 declare function getRotatingFileSink(path: string, options?: RotatingFileSinkOptions): Sink & Disposable;
 //# sourceMappingURL=filesink.node.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"filesink.node.d.ts","sourceRoot":"","sources":["../src/filesink.node.ts"],"names":[],"mappings":";AAGA,OAAO,EACL,KAAK,eAAe,EAGpB,KAAK,sBAAsB,EAC3B,KAAK,uBAAuB,EAC5B,KAAK,IAAI,EACV,MAAM,WAAW,CAAC;AAEnB;;GAEG;AACH,eAAO,MAAM,UAAU,EAAE,sBAAsB,CAAC,MAAM,CASrD,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,eAAoB,GAC5B,IAAI,GAAG,UAAU,CAKnB;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,uBAA4B,GACpC,IAAI,GAAG,UAAU,CAKnB"}

package/types/filesink.web.d.ts

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

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

@@ -1 +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"}
+{"version":3,"file":"filesink.web.d.ts","sourceRoot":"","sources":["../src/filesink.web.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AAMxD;;GAEG;AACH,eAAO,MAAM,SAAS,EAAE,sBAAsB,CAAC,IAAI,CAOlD,CAAC"}

package/types/mod.d.ts

@@ -1,5 +1,5 @@
 export { type Config, ConfigError, configure, dispose, type LoggerConfig, reset, } from "./config.js";
-export { getFileSink } from "./filesink.node.js";
+export { getFileSink, getRotatingFileSink } 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";

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,OAAO,EACP,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"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,MAAM,EACX,WAAW,EACX,SAAS,EACT,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,GACN,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AACtE,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

@@ -115,4 +115,50 @@ export interface FileSinkDriver<TFile> {
  *          object that closes the file when disposed.
  */
 export declare function getFileSink<TFile>(path: string, options: FileSinkOptions & FileSinkDriver<TFile>): Sink & Disposable;
+/**
+ * Options for the {@link getRotatingFileSink} function.
+ */
+export interface RotatingFileSinkOptions extends FileSinkOptions {
+    /**
+     * 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 declare function getRotatingFileSink<TFile>(path: string, options: RotatingFileSinkOptions & RotatingFileSinkDriver<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,GAAG,eAAe,CAgBxB;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"}
+{"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,eAAe,CAgBxB;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;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,eAAe;IAC9D;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB,CAAC,KAAK,CAAE,SAAQ,cAAc,CAAC,KAAK,CAAC;IAC1E;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAEzC;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CACpD;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EACvC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE,uBAAuB,GAAG,sBAAsB,CAAC,KAAK,CAAC,GAC/D,IAAI,GAAG,UAAU,CAkCnB"}