@adze/transport-file

@adze/transport-file is a middleware plugin for AdzeJS writing logs to automatically rotating log files.

This library is built on top of file-stream-rotator and exposes most of its configuration directly with some minor differences.

Installation

# npm
npm i -S @adze/transport-file

#pnpm
pnpm add @adze/transport-file

Project Requirements

This plugin has a peer dependency on adze.

| Runtime | Version | | ---------- | ------------ | | node | >= 18.19.x | | bun | >= 1.1.26 | | deno | >= 1.46.3 | | typescript | >= 5.5.2 |

Usage

import adze, { setup } from 'adze';
import TransportFile from '@adze/transport-file';

const fileTransport = new TransportFile({ directory: './logs' });
await fileTransport.load();

setup({
  // ...your other options
  middleware: [fileTransport],
});

Configuration

@adze/transport-file exposes all of the configuration options of file-stream-rotator directly, with an additional directory option.

If the directory option is declared, then @adze/transport-file will use it with a default log filename pattern. If the filename option is declared, then it will take precedence over the directory option.

For a guide on the options, please visit the readme of file-stream-rotator: Options.