• Synopsis
• Support
• Installation
• Usage
  • ES6
• Configure
• API Reference
• Contributors
• Stack

Synopsis

Winstan.js is an Open source Winston setup wrapper library for easier logging with less code.

• Only 1 small dependency to check inputs variables
• Very lightweight
• Thoroughly tested
• Works in Javascript, Typescript
• Can be used as EcmaScrypt module
• Written in Typescript

Support

• node: 16

This is the oldest targeted versions. The library should work properly on older versions of Node.js but we do not support it officially.

Installation

$ npm i @dwtechs/winstan

Usage

ES6 / TypeScript

import { log } from "@dwtechs/winstan";

log.error(`App cannot start: ${err.msg}`);
log.info(`App started on port : ${PORT}`);
log.debug(`UpdateOne(user=${JSON.stringify(users)})`);

Levels

Winstan reduces log levels to four :

• error,
• warn,
• info,
• debug

Configure

Winstan will start with the following default configuration :

  let defaultSN = "";
  let defaultTZ = "europe/paris";
  let defaultLocale = "fr-FR"
  let defaultNodeEnv = "development";

DefaultSN is the service name. (Or the application name) If provided, it will appear at the beginning of every log. It is useful in a multi-service or multi-application monitoring tool.

You can configure Winstan using 2 methods :

Environment variables

Four environment variables may be used by Winstan :

example :

  LOCALE="en-EN"
  TZ="UTC"
  NODE_ENV="production"
  SERVICE_NAME="ms_user"

These environment variables will update the default values of the lib at start up. So you do not need to init the library in the code.

import { log } from "@dwtechs/winstan";

log.info(`App started on port : ${PORT}`);

TZ is the timezone configuration to set time to your region.

init() method

This method will override ENV variables.

import { log, init } from "@dwtechs/winstan";
const options = {
  timeZone: "UTC",
  locale: "fr-FR",
  serviceName: "ms_user",
  level: "debug"
}
init(options);
log.info(`App started on port : ${PORT}`);

Production mode

Possible values for NODE_ENV environment variable are "production" and "prod". Those values will set Winstan log level to info. Any other value (like "dev" or "development") will set the log level to debug

API Reference

export type Levels = 'error'|'warn'|'info'|'debug';

export type Options = {
  timeZone: string;
  locale: string;
  serviceName: string;
  level: Levels;
};

init(options: Options): void {}

log(size: number): number {}

Express.js utilities

The library comes with a few utilities for Express.js services.

Performances measurement

import express from "express";
import { perf } from '@dwtechs/winstan';

const app = express();
app.use(express.json());
// performance measurement starts for any call to the following routes
app.use(perf.start);
app.use("/", route);
// Performance measurement ends
app.use(perf.end);

Contributors

Winstan.js is still in development and we would be glad to get all the help you can provide. To contribute please read contributor.md for detailed installation guide.

Stack

| Purpose | Choice | Motivation | | :-------------- | :------------------------------------------: | -------------------------------------------------------------: | | repository | Github | hosting for software development version control using Git | | package manager | npm | default node.js package manager | | language | TypeScript | static type checking along with the latest ECMAScript features | | module bundler | Rollup | advanced module bundler for ES6 modules | | unit testing | Jest | delightful testing with a focus on simplicity |