UNPKG

2.04 kBMarkdownView Raw
1# cd-messenger
2### Node and Browser Messages
3#### Use same API across browser or node and it will be handled for you :-)
4
5View on [npm](https://www.npmjs.com/package/cd-messenger)
6
7
8### Install with [npm](npmjs.org)
9
10```sh
11npm install cd-messenger -S
12```
13
14### Usage
15
16```js
17const msg = require('cd-messenger');
18
19// You can use titleCase or lower case for msg methods
20// assuming `name` variable has been set to value before calling below
21
22let name = 'Mike Erickson';
23
24=========================================================================================
25msg.info ('Loading...');
26msg.log (`name: ${name}`); // default color White
27msg.info (`name: ${name}`); // default color Cyan
28msg.success (`name: ${name}`); // default color Green
29msg.warning (`name: ${name}`); // default color Yellow
30msg.error (`name: ${name}`); // default color Red
31msg.note (`name: ${name}`); // default color Orange
32msg.debug (`name: ${name}`); // default color white
33msg.table (array|object) // uses console.table (browser) or nice cli table (node)
34
35=========================================================================================
36msg.line(...)
37msg.line // displays a colored line (you can define line character, color, and width)
38msg.line ('', 'magenta'); // displays a line with solid magenta (no char)
39msg.line ('•', 'green'); // displays a line with repeating '•' and green
40msg.line ('', 'yellow', 40); // display with repeating (40) box, yellow
41
42=========================================================================================
43msg.setOptions(options: object) // customize default browser appearance
44 option.logger (true|false:default) // try it out and see how it looks
45```
46
47
48### License
49
50Copyright (c) 2016-2017 Mike Erickson
51Released under the MIT license
52
53
54### Credits
55
56cd-messenger written by Mike Erickson
57
58E-Mail: [codedungeon@gmail.com](mailto:codedungeon@gmail.com)
59
60Twitter: [@codedungeon](http://twitter.com/codedungeon)
61
62Webiste: [codedungeon.org](http://codedungeon.org)
63
64***