Code Monkey home page Code Monkey logo

bunyan-whatevs-stream's Introduction

bunyan-whatevs-stream

Wrap whatever function you like in such a way that you can use it as a bunyan stream.

Installation

npm install --save bunyan-whatevs-stream

Usage

The interface is straightforward. You give it a function or a Promise that resolves to the function you want it to do. For example, (and this would be a silly way to achieve the goal), but suppose you wanted to use this wrapper to console.log your messages. Try the following:

import bunyan from 'bunyan'
import createStream from 'bunyan-whatevs-stream'

const whatevs = Promise.resolve(console.log)

const logger = bunyan.createLogger({
  level: 'info'
, name: 'bunyan-whatevs-stream-silly-example'
, streams: [ { stream: createStream(whatevs) } ]
})

logger.info('Heya!') // This will end up putting 'Heya!' into stdout

Fun, right?

FAQ

  1. Why would I wrap the function it in a Promise?

Because your whatevs may not be ready to go right when you set up the logger. Perhaps your function calls some system you haven't connected to yet. That's fine. Give it a Promise that resolves to your whatevs.

License

ISC License (ISC) Copyright 2016 Such Software, LLC

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

bunyan-whatevs-stream's People

Contributors

juanpaco avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.