Skip to main content
Home
Browse packagesDocsSign in
This release is 2 versions behind 1.0.4 — the latest version of @logtape/adaptor-winston. Jump to latest

@logtape/adaptor-winston@1.0.2
Built and signed on GitHub Actions

dahlia/logtape

winston adapter for LogTape logging library

This package works with Node.js, Deno, BunIt is unknown whether this package works with Cloudflare Workers, Browsers
It is unknown whether this package works with Cloudflare Workers
This package works with Node.js
This package works with Deno
This package works with Bun
It is unknown whether this package works with Browsers
JSR Score
100%
Published
a week ago (1.0.2)
function install
install(
logger: Logger,
): void

Automatically configures LogTape to route all logs to a winston logger.

This is a convenience function that automatically sets up LogTape to forward all log records to a winston logger instance. By default, it uses winston's default logger, but you can provide a custom logger as the first parameter.

Examples

Basic auto-configuration with default logger

import { install } from "@logtape/adaptor-winston";

// Automatically route all LogTape logs to winston's default logger
install();

// Now any LogTape-enabled library will log through winston
import { getLogger } from "@logtape/logtape";
const logger = getLogger("my-app");
logger.info("This will be logged through winston");

Auto-configuration with custom winston logger

import winston from "winston";
import { install } from "@logtape/adaptor-winston";

const customLogger = winston.createLogger({
  level: "info",
  format: winston.format.combine(
    winston.format.timestamp(),
    winston.format.json()
  ),
  transports: [
    new winston.transports.Console(),
    new winston.transports.File({ filename: "app.log" })
  ]
});

// Install with custom logger
install(customLogger);

Auto-configuration with custom options

import { install } from "@logtape/adaptor-winston";

install(undefined, {
  category: {
    position: "start",
    decorator: "[]",
    separator: "."
  },
  levelsMap: {
    "trace": "debug"  // Map LogTape trace to winston debug
  }
});

Custom logger with custom options

import winston from "winston";
import { install } from "@logtape/adaptor-winston";

const customLogger = winston.createLogger({
  transports: [new winston.transports.Console()]
});

install(customLogger, {
  category: { position: "start", decorator: "[]" }
});

Parameters

logger: Logger

The winston logger instance to use.

optional
options: WinstonSinkOptions

Configuration options for the winston sink behavior.

Return Type

void
install(options?: WinstonSinkOptions): void

Configures LogTape to route all logs to winston's default logger.

Parameters

optional
options: WinstonSinkOptions

Optional configuration for the winston sink behavior.

Return Type

void

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@logtape/adaptor-winston

Import symbol

import { install } from "@logtape/adaptor-winston";
or

Import directly with a jsr specifier

import { install } from "jsr:@logtape/adaptor-winston";

Add Package

pnpm i jsr:@logtape/adaptor-winston
or (using pnpm 10.8 or older)
pnpm dlx jsr add @logtape/adaptor-winston

Import symbol

import { install } from "@logtape/adaptor-winston";

Add Package

yarn add jsr:@logtape/adaptor-winston
or (using Yarn 4.8 or older)
yarn dlx jsr add @logtape/adaptor-winston

Import symbol

import { install } from "@logtape/adaptor-winston";

Add Package

vlt install jsr:@logtape/adaptor-winston

Import symbol

import { install } from "@logtape/adaptor-winston";

Add Package

npx jsr add @logtape/adaptor-winston

Import symbol

import { install } from "@logtape/adaptor-winston";

Add Package

bunx jsr add @logtape/adaptor-winston

Import symbol

import { install } from "@logtape/adaptor-winston";