@logtape/logtape 0.2.0-dev.21 → 0.2.0

package/README.md

@@ -23,7 +23,7 @@ sinks.](#sinks)
 ![](./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
@@ -271,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.

package/package.json

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