# chaos-middleware

> Express middleware for chaos testing

Latest version **0.1.1** (published 2018-09-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install chaos-middleware
pnpm add chaos-middleware
yarn add chaos-middleware
bun add chaos-middleware
```

## 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-09-13 |
| First published | 2018-09-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | take4s5i.0000@gmail.com |
| Maintainers | take4s5i |
| Keywords | chaos, express, middleware |

## Links

- npm: https://www.npmjs.com/package/chaos-middleware
- Repository: https://github.com/take4s5i/chaos-middleware
- Issues: https://github.com/take4s5i/chaos-middleware/issues
- npm.io page: https://npm.io/package/chaos-middleware

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2018-09-13
- 0.1.0 — 2018-09-13

## README

# chaos-middleware
Express middleware for chaos testing

# Usage

```javascript
const chaos = require('chaos-middleware')
const express = require('express')
const app = express()

const options = {
  probability: 0.5,
  rules: [
    { event: 'httpStatus', params: 500 }
  ]
}

app.use(chaos(options))
```

## chaos(options)
create a chaos middleware instance.

- `options` Object
  - `probability` Number (default = 0.1) - probability that is chaos happens. (0.0 - 1.0)
  - `rules` Array<Rule> - rules for chaos.

## Rule
- `event` String - event name. (eg. `httpStatus`)
- `params` Any - parameter for the event.
- `weight` Number ( defualt = 1) - weight for select this rule among the rules.

## Events
An event is a function exposed in `chaos.events`.

### events.httpStatus(status)
Return response with specific status code.

- `status` Number - status code.

### events.delay(amount)
Return normal response with some delay.

- `amount` Number - millseconds to delay.

### events.close()
Close connections.

### events.exit(exitCode = 1)
Exit node process.

- `exitCode` Number - exit code.

### events.kill(signal = "SIGHUP")
Send the signal to self process.

- `signal` Number|String - the signal name or number.

### events.throwError(err)
Throw `err`.

- `err` Any - An error to throw.

### events.reject(err)
Rise `unhandledRejection`.

- `err` Any - An error to reject promises.

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