JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 13383
  • Score
    100M100P100Q133780F
  • License MIT

A pluggable logging utility with built-in colors, styles, and modes.

Package Exports

  • verbalize

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (verbalize) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

verbalize NPM version Build Status

A pluggable logging utility with built-in colors, styles, and modes.

TOC

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm install verbalize --save

Usage

var Verbalize = require('verbalize');

API

Verbalize

Create an instance of Verbalize with the given options.

Params

  • options {Object}

Example

var logger = new Verbalize({verbose: true});

._format

Base formatting.

  • returns {String} msg

._write

Write to the console.

  • returns {String} msg

._writeln

Write to the console followed by a newline. A blank line is returned if no value is passed.

  • returns {String} msg

.write

Write formatted output.

  • returns {String}

.writeln

Write formatted output followed by a newline.

  • returns {String}

.sep

Style a basic separator.

  • returns {String}

.stylize

Stylize the given msg with the specified color.

Params

  • color {String}: The name of the color to use
  • msg {String}: The args to stylize.
  • returns {String}

.define

Define non-enumerable property key with the given value.

Params

  • key {String}
  • value {any}
  • returns {String}

Verbalize.create

Static method to create a new constructor. This is useful in tests and places where the original prototype should not be updated.

Example

var MyLogger = Verbalize.create();
var logger = new MyLogger();
  • base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
  • base-logger: Add a verbalize logger to your base application. | homepage
  • log-events: Create custom, chainable logging methods that emit log events when called. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with [verb][]:

$ npm install verb && npm run docs

Or, if [verb][] is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.

This file was generated by verb, v0.9.0, on March 06, 2016.