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