68 lines
3.6 KiB
Markdown
68 lines
3.6 KiB
Markdown
# beautylog
|
|
beautiful logging, TypeScript ready
|
|
|
|
## Availabililty
|
|
[](https://www.npmjs.com/package/beautylog)
|
|
[](https://GitLab.com/pushrocks/beautylog)
|
|
[](https://github.com/pushrocks/beautylog)
|
|
[](https://pushrocks.gitlab.io/beautylog/)
|
|
|
|
## Status for master
|
|
[](https://GitLab.com/pushrocks/beautylog/commits/master)
|
|
[](https://GitLab.com/pushrocks/beautylog/commits/master)
|
|
[](https://www.npmjs.com/package/beautylog)
|
|
[](https://david-dm.org/pushrocks/beautylog)
|
|
[](https://www.bithound.io/github/pushrocks/beautylog/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/beautylog)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](http://standardjs.com/)
|
|
|
|
## Usage
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
**Quick Demo:**
|
|
[](https://asciinema.org/a/46djsde96ecsho9wqibjx2zye)
|
|
|
|
```javascript
|
|
beautylog.log('some log message') // normal console log message
|
|
beautylog.info('some log message') // info console log message
|
|
beautylog.ok('some log message') // ok console log message
|
|
beautylog.warn('some log message') // warn console log message
|
|
beautylog.success('some success message') // success console log message
|
|
beautylog.error('some error message') // error console log message
|
|
```
|
|
|
|
### Ora Integration
|
|
beautylog wraps the excellent ora module from npm to better work with beautylog. In general that means that you can log persistent messages WHILE you are actually having an active Ora object. beautylog handles all the fuss for you.
|
|
|
|
```javascript
|
|
beautylog.ora.start('Hi, this is some text!', 'blue')
|
|
beautylog.info('some persistent text') //does not disturb ora
|
|
console.log('something') // even this works because console.log is monkeypatched by beautylog
|
|
beautylog.ora.text('some updated text') // switches the text
|
|
beautylog.ora.stop()
|
|
```
|
|
|
|
## Centralized remote logging
|
|
Beautylog makes it easy to have all your node applications log to a remote location.
|
|
|
|
```javascript
|
|
import { Loggly } from 'beautyremote'
|
|
let myLogglyRemote = new Loggly({
|
|
token: 'my_super_long_token_here'
|
|
})
|
|
beautylog.registerRemote(myLogglyRemote)
|
|
```
|
|
|
|
> Note: Beautylog monkeypatches all console log methods.
|
|
There is no need to change anything in your code.
|
|
Everything that is getting logged to your console by node will get logged to a remote as well.
|
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
|
|
|
[](https://push.rocks)
|