npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@runs/logger

v1.0.1

Published

Highly configurable logging based on Winston

Downloads

2

Readme

Build Status

@runs/Logger:

runs-logger is a node logger built on top of Winston logger. The purpose of this package is to add extra features to Winston's default logging, and allow both high customizability, and ease of use.

Installation:

  • npm install @runs/logger
  • yarn add @runs/logger

Usage:

Import/require:

// node:
const Logger = require('@runs/logger');

// ES6 & Typescript
import Logger from '@runs/logger';

Note for TypeScript: This module was written in TypeScript, no need to install @types package.

1. Create new instance:

const logger = new Logger({ /* winston.LoggerOptions */ });

Logger constructor takes 1 argument of type winston.LoggerOptions, interface shown below:

interface LoggerOptions {
  levels?: Config.AbstractConfigSetLevels;
  silent?: boolean;
  format?: logform.Format;
  level?: string;
  exitOnError?: Function | boolean;
  defaultMeta?: any;
  transports?: Transport[] | Transport;
  exceptionHandlers?: any;
}

For more details about nested types, please refer to Winston Types and for usage of these items, please refer to Winston Docs.

2. Start logging:

Example:

logger.log({
    level: 'info', // can be one of: info, warn, error, verbose, debug, or silly
    message: 'Starting server...', // log message
    details: { // optional extra data to include with your log
      port: '3000',
      status: 'ok',
    },
  });
});

That's it.

Behavior:

By default (as of release 1.0.0) logger will log to:

  1. The console during development (NODE_ENV=development).
  2. File named after your app name in your package.json's name attribute, file is called {NAME}-%DATE%.log in logs dir in the root of your app, it'll rotate the file when either the file reaches 20MB, or is 14 days old.