2015-09-20 15:42:50 +00:00
# beautylog
2016-05-03 21:09:57 +00:00
beautiful logging, TypeScript ready
2015-09-27 15:16:43 +00:00
2016-09-02 10:50:07 +00:00
## Availabililty
[](https://www.npmjs.com/package/beautylog)
[](https://gitlab.com/pushrocks/beautylog)
[](https://github.com/pushrocks/beautylog)
[](https://pushrocks.gitlab.io/beautylog/docs)
2016-09-02 10:52:35 +00:00
[](https://pushrocks.gitlab.io/beautylog/api)
2016-09-02 10:50:07 +00:00
## Status for master
2016-05-30 04:40:03 +00:00
[](https://gitlab.com/pushrocks/beautylog/commits/master)
2016-09-02 10:50:07 +00:00
[](https://gitlab.com/pushrocks/beautylog/commits/master)
2015-09-27 15:16:43 +00:00
[](https://david-dm.org/pushrocks/beautylog)
2015-11-23 22:54:14 +00:00
[](https://www.bithound.io/github/pushrocks/beautylog/master/dependencies/npm)
2016-09-02 10:50:07 +00:00
[](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/)
2015-09-27 15:23:32 +00:00
## Usage
2015-11-16 22:32:40 +00:00
2016-05-19 04:53:51 +00:00
```typescript
2016-10-16 00:26:43 +00:00
import * as beautylog from 'beautylog'
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
2015-09-27 15:23:32 +00:00
```
2015-11-16 22:32:40 +00:00
The plugin produces beautiful output like this:
2015-09-30 15:27:01 +00:00
2015-11-16 22:32:40 +00:00
2016-05-19 04:53:51 +00:00
### 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.
2016-01-30 05:19:44 +00:00
2016-05-19 04:53:51 +00:00
```typescript
2016-10-16 00:26:43 +00:00
let myOra = new beautylog.Ora('my awesome text', 'blue')
myOra.start()
beautylog.info('some persistent text') //does not disturb myOra
console.log('something') // even this works because console.log is monkeypatched by beautylog
myOra.text('some updated text')
myOra.stop()
2016-05-19 04:53:51 +00:00
```
2016-01-30 05:19:44 +00:00
2016-07-23 17:47:23 +00:00
## Centralized remote logging
2016-07-23 18:01:30 +00:00
Beautylog makes it easy to have all your node applications log to a remote location.
2016-07-23 17:47:23 +00:00
Currently supported remote providers:
* loggly.com
```typescript
2016-07-23 23:30:30 +00:00
beautylog.remote.loggly({
2016-10-16 00:26:43 +00:00
token: 'loggly-token',
subdomain: 'loggly-subdomain',
appName: 'some App Name',
serverName: 'some Server Name'
})
2016-07-23 17:47:23 +00:00
```
> Note: since 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 loggly as well.
2016-09-02 10:50:07 +00:00
For more information read the docs!
2016-05-19 04:53:51 +00:00
2016-09-02 10:50:07 +00:00
[](https://push.rocks)
