# console-debug-log

> Prints input to stdout only if running in debug mode.

Latest version **1.0.2** (published 2020-03-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install console-debug-log
pnpm add console-debug-log
yarn add console-debug-log
bun add console-debug-log
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-03-22 |
| First published | 2020-03-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 2.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Pragati |
| Maintainers | pragati1610 |
| Keywords | console, log, debug, configure, environment, env |

## Links

- npm: https://www.npmjs.com/package/console-debug-log
- Homepage: https://github.com/GDGVIT/console-debug-log
- npm.io page: https://npm.io/package/console-debug-log

## Alternatives

- [replicas-cli](https://npm.io/package/replicas-cli.md) — 3.0K weekly downloads
- [env-contract](https://npm.io/package/env-contract.md) — 133 weekly downloads
- [@openveo/api](https://npm.io/package/@openveo/api.md) — 61 weekly downloads
- [@ryniaubenpm2/cumque-error-reiciendis](https://npm.io/package/@ryniaubenpm2/cumque-error-reiciendis.md) — 54 weekly downloads
- [ts-global-type-extra](https://npm.io/package/ts-global-type-extra.md) — 11 weekly downloads

## Recent versions

- 1.0.2 (latest) — 2020-03-22
- 1.0.1 — 2020-03-08
- 1.0.0 — 2020-03-08

## README

<p align="center">
	<img src="https://user-images.githubusercontent.com/30529572/72455010-fb38d400-37e7-11ea-9c1e-8cdeb5f5906e.png" />
	<h2 align="center"> Debug logger </h2>
	<h4 align="center"> Node.js tooling to log only in debugging environments <h4>
</p>

--- 

# Functionalities
- [x] Log entries only when DEBUG environment variable is set.
- [ ] Customizable environment variable name for debugging.

<br>


# Instructions to run

* Pre-requisites:
	- Node.js
    - NPM

* Directions to install: 
    - Navigate to your project directory. 
	- Run `npm i -s console-debug-log`

<br>

# Usage instructions
Usage is very straightforward after installation.

## Require in the package
```js
const log = require('console-debug-log');
```

## Log wherever needed
```js
log.debug('Sample Text');
// will print out "Sample Text" to stdout if the DEBUG environment variable is set
```

# Contributors

* [ Pragati ](https://github.com/Pragati1610)

<br>
<br>

<p align="center">
	Made with :heart: by DSC VIT
</p>

---
_Source: https://npm.io/package/console-debug-log · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._