# simple-invariant

> Super-simple invariant function

Latest version **2.0.1** (published 2021-04-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install simple-invariant
pnpm add simple-invariant
yarn add simple-invariant
bun add simple-invariant
```

## 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 | 2.0.1 |
| Published | 2021-04-10 |
| First published | 2020-05-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 0 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Overlook Motel |
| Maintainers | overlookmotel |
| Keywords | invariant |

## Links

- npm: https://www.npmjs.com/package/simple-invariant
- Repository: https://github.com/overlookmotel/simple-invariant
- Homepage: https://github.com/overlookmotel/simple-invariant#readme
- Issues: https://github.com/overlookmotel/simple-invariant/issues
- npm.io page: https://npm.io/package/simple-invariant

## Recent versions

- 2.0.1 (latest) — 2021-04-10
- 2.0.0 — 2020-05-09
- 1.0.0 — 2020-05-03

## README

[![NPM version](https://img.shields.io/npm/v/simple-invariant.svg)](https://www.npmjs.com/package/simple-invariant)
[![Build Status](https://img.shields.io/github/workflow/status/overlookmotel/simple-invariant/Test.svg)](https://github.com/overlookmotel/simple-invariant/actions)
[![Dependency Status](https://img.shields.io/david/overlookmotel/simple-invariant.svg)](https://david-dm.org/overlookmotel/simple-invariant)
[![Dev dependency Status](https://img.shields.io/david/dev/overlookmotel/simple-invariant.svg)](https://david-dm.org/overlookmotel/simple-invariant)
[![Coverage Status](https://img.shields.io/coveralls/overlookmotel/simple-invariant/master.svg)](https://coveralls.io/r/overlookmotel/simple-invariant)

# Super-simple invariant function

## Usage

### What is this package?

It's the simplest possible invariant/assert function. The code is:

```js
function invariant( condition, message ) {
  if ( !condition ) {
    throw new Error( message || 'Invariant failed' );
  }
};
```

So, this code:

```js
if ( !foo ) throw new Error( 'foo must be truthy' );
```

...can be replaced with the shorter:

```js
invariant( foo, 'foo must be truthy' );
```

### Isn't this the same as tiny-invariant?

Pretty much. The only difference is that the error thrown will *always* have the full error message, regardless of whether `process.env.NODE_ENV === 'production'` or not.

## Versioning

This module follows [semver](https://semver.org/). Breaking changes will only be made in major version updates.

All active NodeJS release lines are supported (v10+ at time of writing). After a release line of NodeJS reaches end of life according to [Node's LTS schedule](https://nodejs.org/en/about/releases/), support for that version of Node may be dropped at any time, and this will not be considered a breaking change. Dropping support for a Node version will be made in a minor version update (e.g. 1.2.0 to 1.3.0). If you are using a Node version which is approaching end of life, pin your dependency of this module to patch updates only using tilde (`~`) e.g. `~1.2.3` to avoid breakages.

## Tests

Use `npm test` to run the tests. Use `npm run cover` to check coverage.

## Changelog

See [changelog.md](https://github.com/overlookmotel/simple-invariant/blob/master/changelog.md)

## Issues

If you discover a bug, please raise an issue on Github. https://github.com/overlookmotel/simple-invariant/issues

## Contribution

Pull requests are very welcome. Please:

* ensure all tests pass before submitting PR
* add tests for new features
* document new functionality/API additions in README
* do not add an entry to Changelog (Changelog is created when cutting releases)

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