1 | # Debugging - Boost
|
2 |
|
3 | [![Build Status](https://github.com/milesj/boost/workflows/Build/badge.svg)](https://github.com/milesj/boost/actions?query=branch%3Amaster)
|
4 | [![npm version](https://badge.fury.io/js/%40boost%debug.svg)](https://www.npmjs.com/package/@boost/debug)
|
5 | [![npm deps](https://david-dm.org/milesj/boost.svg?path=packages/debug)](https://www.npmjs.com/package/@boost/debug)
|
6 |
|
7 | Lightweight debugging and crash reporting. Wraps the amazing
|
8 | [debug](https://www.npmjs.com/package/debug) library to provide additional functionality.
|
9 |
|
10 | ```ts
|
11 | import { createDebugger } from '@boost/debug';
|
12 |
|
13 | const debug = createDebugger('boost');
|
14 |
|
15 | debug('Something is broken!');
|
16 | ```
|
17 |
|
18 | ## Features
|
19 |
|
20 | - Isolated and namespaced debugger instances, controlled with the `DEBUG` environment variable.
|
21 | - Crash reporter that logs binary versions, programming languages, running process, system
|
22 | information, and much more.
|
23 | - Standard and verbose debug output.
|
24 | - Toggleable debugging at runtime.
|
25 |
|
26 | ## Installation
|
27 |
|
28 | ```
|
29 | yarn add @boost/debug
|
30 | ```
|
31 |
|
32 | ## Documentation
|
33 |
|
34 | [https://boostlib.dev/docs/debug](https://boostlib.dev/docs/debug)
|