Introduction

Logging module provides a simple way to log messages to console file or any other destination utilizing winston library.

This library aims to be a simple wrapper around a winston library and provides a silvertree module integration.

Installation

pnpm

pnpm install @silvertree/logging

npm

npm install @silvertree/logging

yarn

yarn add @silvertree/logging

Usage

import {InjectLogger, Logger} from '@silvertree/logging'

class MyService {
  @InjectLogger()
  protected readonly logger!: Logger

  public foo() {
    this.logger.info('Hello world!', {some: 'data'})
    // will print to console:
    // 2023-12-12T10:16:45.146Z (MyModule) info: Hello world! { some: 'data' }
  }
}

import {Module} from '@silvertree/core'
import {LoggingModule} from '@silvertree/logging'
import {MyService} from './MyService'

export class MyModule extends Module {
  async setup() {
    await this.import([
      LoggingModule, // import LoggingModule
      MyService,
    ])
  }
}

import {Container} from '@silvertree/core'
import {LoggerRootModule} from '@silvertree/logging'
import {MyModule} from './modules/my-module'

async function main() {
  const container = new Container()
  await container.import([
    LoggerRootModule, // import LoggerRootModule
    MyModule,
  ])
}

start()