npmpackage.info

Gathering detailed insights and metrics for @minswap/tiny-invariant

@minswap/tiny-invariant - 1.2.0 | npmpackage.info

@minswap/tiny-invariant

A tiny invariant function

1.2.0

1,841

MIT

TypeScript

10.47 kB

3.2

Installations

npm install @minswap/tiny-invariant

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

14.19.0

NPM Version

6.14.16 Pull Requests

Open

10

Total

175

Closed

122

Merged

43

Issues

Open

12

Total

30

Closed

18

Releases

1.3.3

v1.3.3

Updated on Feb 23, 2024

1.3.2

v1.3.2

Updated on Feb 23, 2024

1.3.1

v1.3.1

Updated on Sep 28, 2022

1.3.0

v1.3.0

Updated on Sep 28, 2022

1.2.0

v1.2.0

Updated on Oct 31, 2021

1.1.0

v1.1.0

Updated on Jan 30, 2020

View All 13 releases

Languages

TypeScript

JavaScript

TypeScript (69.66%)

JavaScript (30.34%)

Developer

alexreardon

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

1,841 Stars

178 Commits

47 Forks

8 Watchers

90 Branches

12 Contributors

Updated on Jul 09, 2025

Maintainers

View All 12 Contributors

Package Meta Information

Latest Version

1.2.0

Package Id

@minswap/tiny-invariant@1.2.0

Unpacked Size

10.47 kB

Size

4.25 kB

File Count

NPM Version

6.14.16

Node Version

14.19.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@rollup/plugin-replace @rollup/plugin-typescript @size-limit/preset-small-lib @types/jest @types/rollup expect-type jest prettier rimraf rollup rollup-plugin-terser size-limit ts-jest tslib typescript

tiny-invariant 🔬💥

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.

1import invariant from 'tiny-invariant';
2
3invariant(truthyValue, 'This should not throw!');
4
5invariant(falsyValue, 'This will throw!');
6// Error('Invariant violation: This will throw!');

You can also provide a function to generate your message, for when your message is expensive to create

1import invariant from 'tiny-invariant';
2
3invariant(value, () => getExpensiveMessage());

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?')

Type narrowing

tiny-invariant is useful for correctly narrowing types for flow and typescript

1const value: Person | null = { name: 'Alex' }; // type of value == 'Person | null'
2invariant(value, 'Expected value to be a person');
3// type of value has been narrowed to 'Person'

API: `(condition: any, message?: string | (() => string)) => void`

condition is required and can be anything
message optional string or a function that returns a string (() => string)

Installation

1# yarn
2yarn add tiny-invariant
3
4# npm
5npm install tiny-invariant --save

Dropping your `message` for kb savings!

Big idea: you will want your compiler to convert this code:

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

Into this:

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

Babel: recommend babel-plugin-dev-expression
TypeScript: recommend tsdx (or you can run babel-plugin-dev-expression after TypeScript compiling)

Your bundler can then drop the code in the "production" !== process.env.NODE_ENV block for your production builds to end up with this:

1if (!condition) {
2  invariant(false);
3}

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
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!

🤘

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

2

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

2

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

3.2

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

@minswap/tiny-invariant

Installations

Developer Guide

Yes

CommonJS

14.19.0

6.14.16

Pull Requests

10

175

122

43

Issues

12

30

18

Releases

Languages

Developer

alexreardon

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

tiny-invariant 🔬💥

What is invariant?

Why tiny-invariant?

Type narrowing

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

Installation

Dropping your message for kb savings!

Builds

That's it!

10

10

10

2

2

0

0

0

0

0

0

0

3.2

/10

What is `invariant`?

Why `tiny-invariant`?

API: `(condition: any, message?: string | (() => string)) => void`

Dropping your `message` for kb savings!