Skip to content
A tiny invariant function
JavaScript
Branch: master
Clone or download
Latest commit 7812fd0 Jul 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
flow-typed/npm updating flowtype Mar 27, 2019
src allow any type for the condition Jul 13, 2019
test correcting entry point for bundle size test Mar 27, 2019
.babelrc upgrading deps Oct 2, 2018
.browserslistrc upgrading flow and jest Mar 27, 2019
.flowconfig initial Apr 17, 2018
.gitignore stripping comments Apr 17, 2018
.prettierrc initial Apr 17, 2018
.travis.yml adding travis Apr 17, 2018
LICENSE adding MIT license file Mar 27, 2019
README.md Update README.md Jul 7, 2019
jest.config.js upgrading flow and jest Mar 27, 2019
package.json v1.0.6 Jul 15, 2019
rollup.config.js going smaller Aug 13, 2018
yarn.lock bumping deps to latest Jul 8, 2019

README.md

tiny-invariant 🔬💥

Build Status npm dependencies min minzip

A tiny invariant alternative.

What is invariant?

An invariant function takes a value, and if the value is falsy then the invariant function will throw. If the value is truthy, then the function will not throw.

import invariant from 'tiny-invariant';

invariant(truthyValue, 'This should not throw!');

invariant(falsyValue, 'This will throw!');
// Error('Invariant violation: This will throw!');

Why tiny-invariant?

The library: invariant supports passing in arguments to the invariant function in a sprintf style (condition, format, a, b, c, d, e, f). It has internal logic to execute the sprintf substitutions. The sprintf logic is not removed in production builds. tiny-invariant has dropped all of the sprintf logic. tiny-invariant allows you to pass a single string message. With template literals there is really no need for a custom message formatter to be built into the library. If you need a multi part message you can just do this: invariant(condition, 'Hello, ${name} - how are you today?')

API: (condition: mixed, message?: string) => void

  • condition is required and can be anything
  • message is an optional string

Installation

# yarn
yarn add tiny-invariant

# bash
npm add tiny-invariant --save

Dropping your message for kb savings!

We recommend using babel-plugin-dev-expression to remove the message argument from your invariant calls in production builds to save kbs!

What it does it turn your code that looks like this:

invariant(condition, 'My cool message that takes up a lot of kbs');

Into this

if (!condition) {
  if ('production' !== process.env.NODE_ENV) {
    invariant(false, 'My cool message that takes up a lot of kbs');
  } else {
    invariant(false);
  }
}

Your bundler can then drop the code in the "production" !== process.env.NODE_ENV block for your production builds

Final result:

if (!condition) {
  invariant(false);
}

For rollup use rollup-plugin-replace and set NODE_ENV to production and then rollup will treeshake out the unused code

Webpack instructions

Builds

  • We have a es (EcmaScript module) build (because you know you want to deduplicate this super heavy library)
  • We have a cjs (CommonJS) build
  • We have a umd (Universal module definition) build in case you needed it

We expect process.env.NODE_ENV to be available at module compilation. We cache this value

That's it!

🤘

You can’t perform that action at this time.