UNPKG

2.13 kBMarkdownView Raw
1# cd-messenger
2### Node and Browser Messages
3Use same API across browser or node and cd-messenger will handle the rest for you!
4
5
6View on [npm](https://www.npmjs.com/package/cd-messenger)
7
8
9### Install with [npm](npmjs.org)
10
11```sh
12npm 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
23const 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
28let name = 'Mike Erickson';
29
30=========================================================================================
31msg.info ('Loading...');
32msg.log (`name: ${name}`); // default color White
33msg.info (`name: ${name}`); // default color Cyan
34msg.success (`name: ${name}`); // default color Green
35msg.warning (`name: ${name}`); // default color Yellow
36msg.error (`name: ${name}`); // default color Red
37msg.note (`name: ${name}`); // default color Orange
38msg.debug (`name: ${name}`); // default color white
39msg.table (array|object) // uses console.table (browser) or nice cli table (node)
40
41=========================================================================================
42msg.line(...)
43msg.line // displays a colored line (you can define line character, color, and width)
44msg.line ('', 'magenta'); // displays a line with solid magenta (no char)
45msg.line ('•', 'green'); // displays a line with repeating '•' and green
46msg.line ('', 'yellow', 40); // display with repeating (40) box, yellow
47
48=========================================================================================
49msg.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
56Copyright (c) 2016-2017 Mike Erickson
57Released under the MIT license
58
59
60### Credits
61
62cd-messenger written by Mike Erickson
63
64E-Mail: [codedungeon@gmail.com](mailto:codedungeon@gmail.com)
65
66Twitter: [@codedungeon](http://twitter.com/codedungeon)
67
68Webiste: [codedungeon.org](http://codedungeon.org)
69
70***