npmpackage.info

tiny-invariant

A tiny invariant function

1.3.3

1,717

MIT

TypeScript

254.00 B

1,758,559,979 3.6

Installations

npm install tiny-invariant

Pull Requests

Open

10

Total

174

Closed

121

Merged

43

Issues

Open

11

Total

29

Closed

18

Releases

1.3.3

v1.3.3

Published on 23 Feb 2024

1.3.2

v1.3.2

Published on 23 Feb 2024

1.3.1

v1.3.1

Published on 28 Sept 2022

1.3.0

v1.3.0

Published on 28 Sept 2022

1.2.0

v1.2.0

Published on 31 Oct 2021

1.1.0

v1.1.0

Published on 30 Jan 2020

View all 13 releases

Developer

alexreardon

Developer Guide

BETA

Module System

CommonJS, ESM

Min. Node Version

Typescript Support

Yes

Node Version

21.6.2

NPM Version

10.2.4 Statistics

1,717 Stars

178 Commits

48 Forks

9 Watching

90 Branches

12 Contributors

Updated on 27 Nov 2024

Bundle Size

368.00 B

Minified

254.00 B

Minified + Gzipped

Bundlephobia

Languages

TypeScript (69.66%)

JavaScript (30.34%)

Total Downloads

Cumulative downloads

Total Downloads

1,758,559,979

Last day

-1.3%

2,623,256

Compared to previous day

Last week

3.6%

13,538,894

Compared to previous week

Last month

11.4%

56,681,766

Compared to previous month

Last year

38.1%

574,538,986

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

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

Versions

tiny-invariant 🔬💥

GitHub Actions Workflow Status npm bundle size NPM Downloads

tiny-invariant is a tiny, widely-supported, zero-dependency alternative to invariant.

tiny-invariant - when every byte counts!

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!');

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 code for sprintf logic and instead encourages consumers to leverage template literals for message formatting.

1invariant(condition, `Hello, ${name} - how are you today?`);

Error Messages

tiny-invariant allows you to pass a string message, or a function that returns a string message. Using a function that returns a message is helpful when your message is expensive to create.

1import invariant from 'tiny-invariant';
2
3invariant(condition, `Hello, ${name} - how are you today?`);
4
5// Using a function is helpful when your message is expensive
6invariant(value, () => getExpensiveMessage());

When process.env.NODE_ENV is set to production, the message will be replaced with the generic message Invariant failed.

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

Dangerous-Workflow

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

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

6

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

Code-Review

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

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.6

/10

Last Scanned on 2024-11-25

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

Other packages similar to tiny-invariant

ts-tiny-invariant

2.0.5

Stricter version of tiny-invariant

@minswap/tiny-invariant

1.2.0

A tiny invariant function

smart-invariant

2.0.0

Like invariant and tiny-invariant, but smarter

@d.richardcarl/tiny-invariant

1.3.3

A tiny invariant function

tiny-invariant

Installations

Pull Requests

10

174

121

43

Issues

11

29

18

Releases

Developer

alexreardon

Developer Guide

CommonJS, ESM

Yes

21.6.2

10.2.4

Statistics

Bundle Size

368.00 B

254.00 B

Languages

Total Downloads

1,758,559,979

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

tiny-invariant 🔬💥

What is invariant?

Why tiny-invariant?

Error Messages

Type narrowing

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

Installation

Dropping your message for kb savings!

Builds

That's it!

10

10

10

6

2

0

0

0

0

0

0

0

3.6

/10

Other packages similar to tiny-invariant

What is `invariant`?

Why `tiny-invariant`?

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

Dropping your `message` for kb savings!