# console-suppress

> Augments console methods with message suppressing capabilities.

Latest version **0.1.1** (published 2018-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install console-suppress
pnpm add console-suppress
yarn add console-suppress
bun add console-suppress
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2018-03-31 |
| First published | 2018-03-31 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 115.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8 |
| Author | Lucas Constantino Silva |
| Maintainers | lucasconstantino |
| Keywords | console, logger, log, test, suppress |

## Links

- npm: https://www.npmjs.com/package/console-suppress
- Repository: https://github.com/lucasconstantino/console-suppress
- Homepage: https://github.com/lucasconstantino/console-suppress#readme
- Issues: https://github.com/lucasconstantino/console-suppress/issues
- npm.io page: https://npm.io/package/console-suppress

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [vest](https://npm.io/package/vest.md) — 50.1K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2018-03-31
- 0.1.0 — 2018-03-31

## README

# Console Suppress

Augments console methods with message suppressing capabilities. Very useful during testing.

![Build status](https://travis-ci.org/lucasconstantino/console-suppress.svg?branch=master)

## Installation

This package is available on [npm](https://www.npmjs.com/package/console-suppress) as: *console-suppress*

```
npm install --dev console-suppress
```

## Basic usage

```js
import console from 'console-suppress'

console.log.suppress(/undesired/)
console.log('some undesired log') // not logged to the console.
```

## API

At the context of this documentation, *suppressor* means either a RegExp instance, a string (which will eventually be converted to a regex for comparison) or an array of the previous two.

**Adding suppressors:**

| Method | Arguments | Description |
| ------ | --------- | ----------- |
| console.suppress | *suppressor* | Registers a suppressor for all method calls.
| console.log.suppress | *suppressor* | Registers a suppressor for `console.log` calls.
| console.info.suppress | *suppressor* | Registers a suppressor for `console.info` calls.
| console.warn.suppress | *suppressor* | Registers a suppressor for `console.warn` calls.
| console.error.suppress | *suppressor* | Registers a suppressor for `console.error` calls.

**Removing suppressors:**

| Method | Arguments | Description |
| ------ | --------- | ----------- |
| console.cleanSuppressor | *suppressor* | Removes the given suppressor for any logging method calls.
| console.log.cleanSuppressor | *suppressor* | Removes the given suppressor for `console.log` calls.
| console.info.cleanSuppressor | *suppressor* | Removes the given suppressor for `console.info` calls.
| console.warn.cleanSuppressor | *suppressor* | Removes the given suppressor for `console.warn` calls.
| console.error.cleanSuppressor | *suppressor* | Removes the given suppressor for `console.error` calls.
| console.cleanSuppressors | [*suppressor*] | Removes given suppressors (or all, if none provided) any logging method calls.
| console.log.cleanSuppressors | [*suppressor*] | Removes given suppressors (or all, if none provided) for `console.log` calls.
| console.info.cleanSuppressors | [*suppressor*] | Removes given suppressors (or all, if none provided) for `console.info` calls.
| console.warn.cleanSuppressors | [*suppressor*] | Removes given suppressors (or all, if none provided) for `console.warn` calls.
| console.error.cleanSuppressors | [*suppressor*] | Removes given suppressors (or all, if none provided) for `console.error` calls.

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