70 lines
3.3 KiB
Markdown
70 lines
3.3 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/docs)
|
|
[](https://pushrocks.gitlab.io/beautylog/api)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/beautylog/commits/master)
|
|
[](https://gitlab.com/pushrocks/beautylog/commits/master)
|
|
[](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/)
|
|
|
|
## Usage
|
|
|
|
```typescript
|
|
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
|
|
```
|
|
The plugin produces beautiful output like this:
|
|
|
|
|
|
### 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.
|
|
|
|
```typescript
|
|
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()
|
|
```
|
|
|
|
## Centralized remote logging
|
|
Beautylog makes it easy to have all your node applications log to a remote location.
|
|
|
|
Currently supported remote providers:
|
|
|
|
* loggly.com
|
|
|
|
```typescript
|
|
beautylog.remote.loggly({
|
|
token: 'loggly-token',
|
|
subdomain: 'loggly-subdomain',
|
|
appName: 'some App Name',
|
|
serverName: 'some Server Name'
|
|
})
|
|
```
|
|
|
|
> 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.
|
|
|
|
For more information read the docs!
|
|
|
|
[](https://push.rocks)
|