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
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
2017-01-22 10:42:04 +00:00
beautylog.ora.start('Hi, this is some text!', 'blue')
beautylog.info('some persistent text') //does not disturb ora
2016-10-16 00:26:43 +00:00
console.log('something') // even this works because console.log is monkeypatched by beautylog
2017-01-22 10:42:04 +00:00
beautylog.ora.text('some updated text') // switches the text
beautylog.ora.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
```typescript
2017-01-22 10:42:04 +00:00
import { Loggly } from 'beautyremote'
let myLogglyRemote = new Loggly({
token: 'my_super_long_token_here'
2016-10-16 00:26:43 +00:00
})
2017-01-22 10:42:04 +00:00
beautylog.registerRemote(myLogglyRemote)
2016-07-23 17:47:23 +00:00
```
2017-01-22 10:42:04 +00:00
> Note: Beautylog monkeypatches all console log methods.
2016-07-23 17:47:23 +00:00
There is no need to change anything in your code.
2017-01-22 10:42:04 +00:00
Everything that is getting logged to your console by node will get logged to a remote as well.
2016-07-23 17:47:23 +00:00
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)
