JSPM

caroline

0.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 800
  • Score
    100M100P100Q95807F

colourful console output for node.js

Package Exports

  • caroline

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 (caroline) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

caroline

A small terminal color library and logger for Node.js based on ANSI escape codes.

Installation

npm install caroline

Example

var logger = require('caroline');
console.log(logger.bg.red(logger.color.cyan(logger.style.italic('Test'))));

logger.print('Text', {
  color : 'white',
  background : 'green',
  bold : true,
  italic : true
});

API Documentation

caroline.style

  • bold(text)
  • italic(text)
  • underline(text)

caroline.color

  • black(text)
  • red(text)
  • green(text)
  • yellow(text)
  • blue(text)
  • magenta(text)
  • cyan(text)
  • white(text)
  • gray(text)

caroline.background

  • black(text)
  • red(text)
  • green(text)
  • yellow(text)
  • blue(text)
  • magenta(text)
  • cyan(text)
  • white(text)

caroline.print(text, [options])

var logger = require('caroline');
logger.print('Italic text', {
  italic : true
});

logger.print('Underline text', {
  underline : true
});

logger.print('Bold text', {
  bold : true
});

Log messages

  • caroline.log('Log message', [arg1, args2 ...])
  • caroline.info('Info message', [arg1, args2 ...])
  • caroline.warn('Warn message', [arg1, args2 ...])
  • caroline.error('Error message', [arg1, args2 ...])

Convenience methods

  • caroline.enable()
  • caroline.disable() - Enable/disable logging
  • caroline.disableColors() - Disable the coloring of the output
  • caroline.enableColors()
  • caroline.hidePrefixes() - Don't show the LOG|INFO etc. prefix
  • caroline.showPrefixes()
  • caroline.hideTimestamps() - Don't display the timestamp
  • caroline.showTimestamps()

Run the tests

npm test