https://github.com/willybrauner/debug
Tiny debug tool (~500 bytes) for terminal and browser inspired by debug-js/debug API.
https://github.com/willybrauner/debug
browser debug javascript lib library log node-js nodejs
Last synced: 3 months ago
JSON representation
Tiny debug tool (~500 bytes) for terminal and browser inspired by debug-js/debug API.
- Host: GitHub
- URL: https://github.com/willybrauner/debug
- Owner: willybrauner
- License: mit
- Created: 2021-08-25T14:42:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T14:51:10.000Z (11 months ago)
- Last Synced: 2025-03-27T12:52:39.689Z (4 months ago)
- Topics: browser, debug, javascript, lib, library, log, node-js, nodejs
- Language: TypeScript
- Homepage:
- Size: 267 KB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @wbe/debug
Tiny debug tool (~500 bytes) for terminal and browser inspired by [debug-js/debug](https://github.com/debug-js/debug) API.
## Motivation
`@wbe/debug` was built in order to be as light as possible for terminal and browser,
as the same way as the great debug-js/debug tool.
## Installation
```shell script
$ npm i @wbe/debug
```
## debug node
```shell
DEBUG=* node file.js
```
file.js:
```js
import debug from "@wbe/debug"
const log = debug("namespace")
log("hello") // "namespace hello"
```
`process.env.DEBUG` value can be defined as a specific namespace too:
```shell
DEBUG=namespace-1 node file.js
```
Only debug function declaration with `namespace-1` declared as namespace will be printed in the console:
```js
import debug from "@wbe/debug"
const log = debug("namespace-1")
log("hello") // "namespace-1 hello"
```
`process.env.DEBUG` value accept "one glob parameter level":
```shell
DEBUG=config:* node file.js
```
Every debug function declaration with namespace `config:{somestring}` will be logged.
## debug in browser
In the same way as nodejs usage, `debug` is browser compatible with the same API. The only difference is
we need to set the current namespace in localStorage.
Add on your browser localStorage:
```shell
localStorage.debug = "foo"
```
Use debug in javascript:
```js
// es6 import
import debug from "@wbe/debug"
const log = debug("foo")
log("bar") // "foo bar"
```
## Examples
Install dependencies:
```shell
pnpm i
```
Start example:
```shell
# browser example
npm run dev:example-browser
# node example
npm run dev:example-dev
```
## Credits
Willy Brauner
## Licence
MIT