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

inv-loggers

v3.3.15

Published

loggers and partial loggers

Downloads

37

Readme

a little server-side library to log things with colors, with a special care for promise chains

Summary

Installation

in a terminal at your project root:

npm install inv-loggers --save

then in your javascript project:

var log = require('inv-loggers')

or as I prefer, extend your _ object

var _ = require('lodash') // or var _ = require('underscore')
var loggers = require('inv-loggers')
_.extend _, loggers

this is the syntax we will use in the following examples

Functions

Basics

log

the basic logger from which all others are just variations

var obj = {a: 1}
_.log(obj, 'that zuper obj')

which in logs, generate something like:

****** that zuper obj ******
{ a: 1 }
-----

with some colors that can't be made visible in this markdown file (in the caseof _.log, cyan)

And that's pretty much all: a label with fat delimiters and some colors to make your debugging/logs scanning easy

NB: returns the object for convenience

success

The same but in green

info

The same but in blue

warn

The same but in yellow

NB: returns undefined to avoid returning an error object

error

The same but in red, used to log error objects.

It will try to log err.stack instead of just the err object to get a stack trace in logs when available

NB: returns undefined to avoid returning an error object

errorRethrow

The same as error but throws the error object instead of just returning undefined (especially useful used as a partial in a promise chain, see hereafter)

Partials

in promise chains, it can be useful to log an object passed at the middle of the chain, but using just those loggers would be sub-optimal, verbose:

getSomeData()
.then(function (result) { return _.log(result, 'some data') })
.then(doSomethingWithIt)
.catch(function (error) { _.error(error, 'some data error')})

so we use partials instead, to which we pass a label and which returns a function with a label pre-set. So we can rewrite this example like so:

getSomeData()
.then(_.Log('some data'))
.then(doSomethingWithIt)
.catch(_.Error('some data error'))

Note here that if we want to be able to log an error generated in this chain but still be able to handle it elsewhere, we need to make sure the error is rethrown, which can be done by replacing the last line with

.catch(_.ErrorRethrow('some data error'))

The partial functions have the same name as the basic functions but simply capitalized: Log, Info, Success, Warn, Error, ErrorRethrow

Capitalizing high-order functions as such is a convention used in my projects as I use very few constructors, but you might thing it is an heretic choice. In this case, don't use this library.

License

MIT