https://github.com/doesdev/bock

Bock is a strong lager (logger) of German (US) origin
https://github.com/doesdev/bock

Last synced: 11 months ago
JSON representation

Bock is a strong lager (logger) of German (US) origin

• Host: GitHub
• URL: https://github.com/doesdev/bock
• Owner: doesdev
• License: mit
• Created: 2017-03-10T02:25:06.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-09-22T16:47:17.000Z (over 4 years ago)
• Last Synced: 2025-02-20T03:17:12.581Z (11 months ago)
• Language: JavaScript
• Size: 101 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# bock [![NPM version](https://badge.fury.io/js/bock.svg)](https://npmjs.org/package/bock)   [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)   [![Build Status](https://travis-ci.com/doesdev/bock.svg)](https://travis-ci.com/doesdev/bock)

> Bock is a strong ~~lager~~ logger of ~~German~~ US origin

## install

```sh

$ npm install --save bock

```

## usage

```js

const options = { appName: 'myAwesomeApp', logLevel: 'warn', toFile: true }

const bock = require('bock')(options)

bock.fatal(new Error('something went wrong'))

```

## api

Bock exports a primary function which returns an instance with methods

(`debug`, `info`, `warn`, `fatal`, `setLogLevel`, `close`)

- **options** *(Object - optional)*

  - **appName** *(String - optional - default: 'bock')* Base name to use for log files (`${appName}-${month}-${day}-${year}.json`)

  - **logBase** *(String - optional - default: `__dirname + '/logs'`)* Path for log files

  - **logLevel** *(String - optional - default: 'debug')* Threshold for logging (i.e. if warn it won't log debug or info errors)

  - **newline** *(Boolean - optional - default: `true`)* Use newline delimited JSON (highly recommended for performance reasons)

  - **toConsole** *(Boolean - optional - default: true)* Should log to console

  - **toFile** *(Boolean - optional - default: true)* Should log to file

  - **whitelist** *(Array - optional)* List of ignored error types / messages

  - **track** *(Boolean - optional - default: false)* Should log methods return

  a `Promise` indicating the log was written

Each of the four methods (`debug`, `info`, `warn`, `fatal`) accept an `Error`

object, a string, or a function that returns one of those two things. They also

accept a second argument (`transform`) which is a function that will accept as

its only argument the final text output to file and/or console, and what it

returns will the text value to be logged. This is primarily useful for

cleansing sensitive information from the output.

Where `const logger = bock([opts])` (i.e. on an instance) the following methods

are also available

`logger.setLogLevel(string logLevel)` Changes logLevel setting on instance

`logger.close()` Close forked process used for file writing

Additionally, you can choose to use the `bock.cached([opts])` which will return

the last instance instantiated using the `cached` method or create a new one

with the passed opts (and cache it).

## license

MIT © [Andrew Carpenter](https://github.com/doesdev)