Home

Awesome

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

Example

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

._format

Base formatting.

._write

Write to the console.

._writeln

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

.write

Write formatted output.

.writeln

Write formatted output followed by a newline.

.sep

Style a basic separator.

.stylize

Stylize the given msg with the specified color.

Params

.define

Define non-enumerable property key with the given value.

Params

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();

Related projects

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.