# max-buffer-exceeded-error

> A better error class for 'maxBuffer exceeded' errors

Latest version **1.0.1** (published 2016-10-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install max-buffer-exceeded-error
pnpm add max-buffer-exceeded-error
yarn add max-buffer-exceeded-error
bun add max-buffer-exceeded-error
```

## 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.1 |
| Published | 2016-10-29 |
| First published | 2015-11-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Shinnosuke Watanabe |
| Maintainers | shinnn |
| Keywords | max, limit, buffer, exceed, error, exec, execfile, exec-file, class, constructor, inheritance, superclass, super, custom |

## Links

- npm: https://www.npmjs.com/package/max-buffer-exceeded-error
- Repository: https://github.com/shinnn/max-buffer-exceeded-error
- Homepage: https://github.com/shinnn/max-buffer-exceeded-error#readme
- Issues: https://github.com/shinnn/max-buffer-exceeded-error/issues
- npm.io page: https://npm.io/package/max-buffer-exceeded-error

## Dependencies (1)

- [create-error-class](https://npm.io/package/create-error-class.md) ^3.0.2

## Alternatives

- [@sentry/react-native](https://npm.io/package/@sentry/react-native.md) — 2.6M weekly downloads
- [@ardatan/aggregate-error](https://npm.io/package/@ardatan/aggregate-error.md) — 708.1K weekly downloads
- [custom-error-generator](https://npm.io/package/custom-error-generator.md) — 2.0K weekly downloads
- [@technik-sde/prosemirror-recreate-transform](https://npm.io/package/@technik-sde/prosemirror-recreate-transform.md) — 1.5K weekly downloads
- [@suchipi/error-utils](https://npm.io/package/@suchipi/error-utils.md) — 78 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-10-29
- 1.0.0 — 2015-11-28

## README

# max-buffer-exceeded-error

[![NPM version](https://img.shields.io/npm/v/max-buffer-exceeded-error.svg)](https://www.npmjs.com/package/max-buffer-exceeded-error)
[![Build Status](https://travis-ci.org/shinnn/max-buffer-exceeded-error.svg?branch=master)](https://travis-ci.org/shinnn/max-buffer-exceeded-error)
[![Coverage Status](https://img.shields.io/coveralls/shinnn/max-buffer-exceeded-error.svg)](https://coveralls.io/github/shinnn/max-buffer-exceeded-error)
[![Dependency Status](https://david-dm.org/shinnn/max-buffer-exceeded-error.svg)](https://david-dm.org/shinnn/max-buffer-exceeded-error)
[![devDependency Status](https://david-dm.org/shinnn/max-buffer-exceeded-error/dev-status.svg)](https://david-dm.org/shinnn/max-buffer-exceeded-error#info=devDependencies)

A better `Error` class for "maxBuffer exceeded" errors

```javascript
const {execFile} = require('child_process');

execFile('npm', {maxBuffer: 10}, err => {
  err; //=> Error: stdout maxBuffer exceeded
});
```

```javascript
const MaxBufferExceededError = require('max-buffer-exceeded-error');

new MaxBufferExceededError('stdout', 10);
/*
  => { [MaxBufferExceededError: stdout maxBuffer exceeded. (>10)]
       message: 'stdout maxBuffer exceeded. (>10)',
       maxBuffer: 10 }
*/
```

## Installation

[Use npm.](https://docs.npmjs.com/cli/install)

```
npm install max-buffer-exceeded-error
```

## API

```javascript
const MaxBufferExceededError = require('max-buffer-exceeded-error');
```

### new MaxBufferExceededError(*name*. *maxBuffer*)

*name*: `String` (a name of what limits the buffer size e.g. `stdout`, `stderr`)  
*maxBuffer*: `number` (size of the max buffer)  
Return: `MaxBufferExceededError` instance

## License

Copyright (c) 2015 [Shinnosuke Watanabe](https://github.com/shinnn)

Licensed under [the MIT License](./LICENSE).

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