node-strings
v1.0.2
Published
The easiest way to have bold, underlined, or colored strings in node console
Downloads
405
Maintainers
Readme
node-strings
This module is for pragmatic developers that need to easily and quickly enhance some NodeJS console log.
It's based on node core util.inspect.colors
info, and it uses the ancient, obtrusive but handy technique of polluting String.prototype
since it's full of trash anyway thanks to early Web days ...
(I mean ... seriously: 'wtf'.bold()
produces '<b>wtf</b>'
in NodeJS ... IN NODE JS!!!)
If you think the world will stop because somebody made a String.prototype.bold
that produces bold text in a node console,
please consider better alternatives such Chalk, Colors, Cli-colors, or even Coolors. These proudly don't probably extend String.prototype
and do much more.
If like me you just need to debug or temporarily enhance some string in console, without touching anything else, simply adding .bold()
at the end of some log, I'm glad you found this little module with zero dependencies and huge portability useful.
API
You can use, combine, and chain any of the following methods:
str.italic()
to make some text italic (Linux)str.strike()
to strike through some text (Linux)str.hidden()
to create hidden text (Linux, Mac)str.underline()
to underline some text (Linux, Mac)str.blink()
to create a text that blinks (Mac, highlighted on Win)str.bold()
to make some text boldstr.inverse()
to invert background and foreground colorsstr.white()
to use white as colorstr.grey()
to use grey as colorstr.black()
to use black as colorstr.blue()
to use blue as colorstr.cyan()
to use cyan as colorstr.green()
to use green as colorstr.magenta()
to use magenta as colorstr.red()
to use red as colorstr.yellow()
to use yellow as color
In alternative, you can use the returned object as generic transformer:
// import the module
var strings = require('node-strings');
// use it like this if you like
console.log(strings.blink('Hello World'));
// instead of the following
console.log('Hello World'.blink());
You can see all exported methods by simply running npm test
.
No check whatsoever for previously possibly available methods is done.
However, you can eventually reach original method via ''.bold.original
but I doubt you'll ever need to do so.