node-is-logger

Table of Contents

• Synopsis
• Usage
• Installation
• API Reference
• Tests
  • Run unit tests
• Compatibility
  • Node
  • Browser
• Contributing
• Contributing
• Credits
• History
• License

Synopsis

Verify if a value seems or is a logger, including "standardized" methods: debug, info, error... - as Bunyan or Winston.

Usage

   const isLogger = require('is-logger');
   const bunyan = require('bunyan');
 
   const LOG = bunyan.createLogger({name: __filename});
   const FAKE_LOG = {name: 'I am a fake logger!'};
 
   console.log(isLogger(LOG))
   # >>> return true: LOG is a logger.
 
   console.log(isLogger(FAKE_LOG);
   # >>> return false: FAKE_LOG is not a logger.
 
   console.log(isLogger(FAKE_LOG, {throwOnFalse: true});
   # >>> throw an error of type `IsNotLoggerError`: FAKE_LOG is not a logger.
 

Installation

npm install is-logger

API Reference

Please refer to API documentation.

Tests

Run unit tests

npm test

Compatibility

Node

Tested using Node v9.4.0.

Browser

Untested at this time.

Issues

Feel free to submit issues and enhancement requests.

Contributing

Please refer to project's style guidelines and guidelines for submitting patches and additions. In general, we follow the "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Credits

History

v0.1.1 (2018-02-08)

• Update require-dir to the latest version

v0.1.0 (2018-01-28)

Fix bug: bad entry point in package.json.

v0.1.0-beta2 (2018-01-28)

Fix badges & documentation.

v0.1.0-beta1 (2018-01-28)

Fix bugs: invalid NPM badge.

v0.1.0-alpha2 (2018-01-28)

Finalizing code, tests and automated generation of documentation.

v0.1.0-alpha1 (2018-01-24)

Initial version.

License

The MIT License

Copyright (c) 2018 SAS 9 Février

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.