3.8.94 • Published 1 year ago

@diotoborg/consectetur-modi-reprehenderit v3.8.94

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

@diotoborg/consectetur-modi-reprehenderit šŸ”¬šŸ’„

GitHub Actions Workflow Status types npm bundle size NPM Downloads

@diotoborg/consectetur-modi-reprehenderit is a tiny, widely-supported, zero-dependency alternative to invariant.

@diotoborg/consectetur-modi-reprehenderit - 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.

import invariant from '@diotoborg/consectetur-modi-reprehenderit';

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

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

Why @diotoborg/consectetur-modi-reprehenderit?

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. @diotoborg/consectetur-modi-reprehenderit has dropped all of the code for sprintf logic and instead encourages consumers to leverage template literals for message formatting.

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

Error Messages

@diotoborg/consectetur-modi-reprehenderit 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.

import invariant from '@diotoborg/consectetur-modi-reprehenderit';

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

// Using a function is helpful when your message is expensive
invariant(value, () => getExpensiveMessage());

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

Type narrowing

@diotoborg/consectetur-modi-reprehenderit is useful for correctly narrowing types for flow and typescript

const value: Person | null = { name: 'Alex' }; // type of value == 'Person | null'
invariant(value, 'Expected value to be a person');
// 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

# yarn
yarn add @diotoborg/consectetur-modi-reprehenderit

# npm
npm install @diotoborg/consectetur-modi-reprehenderit --save

Dropping your message for kb savings!

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

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 to end up with this:

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

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!

🤘

3.8.94

1 year ago

3.8.93

1 year ago

3.8.92

1 year ago

3.8.91

1 year ago

3.8.90

1 year ago

3.8.89

1 year ago

3.8.88

1 year ago

3.8.87

1 year ago

3.8.86

1 year ago

3.8.85

1 year ago

3.7.85

1 year ago

3.7.84

1 year ago

3.7.83

1 year ago

3.7.82

1 year ago

3.7.81

1 year ago

3.7.80

1 year ago

3.7.79

1 year ago

3.7.78

1 year ago

3.7.77

1 year ago

3.7.76

1 year ago

3.7.75

1 year ago

3.7.74

1 year ago

3.7.73

1 year ago

3.7.72

1 year ago

3.7.71

1 year ago

3.7.70

1 year ago

3.7.69

1 year ago

3.7.68

1 year ago

3.6.68

1 year ago

3.6.67

1 year ago

3.6.66

1 year ago

3.5.66

1 year ago

3.5.65

1 year ago

3.5.64

1 year ago

3.5.63

1 year ago

3.4.63

1 year ago

3.3.63

1 year ago

3.2.63

1 year ago

3.2.62

1 year ago

3.2.61

1 year ago

3.2.60

1 year ago

3.2.59

1 year ago

3.2.58

1 year ago

3.2.57

1 year ago

3.2.56

1 year ago

3.2.55

1 year ago

3.2.54

1 year ago

3.2.53

1 year ago

3.2.52

1 year ago

3.1.52

1 year ago

3.1.51

1 year ago

3.1.50

1 year ago

3.1.49

1 year ago

3.1.48

1 year ago

3.1.47

1 year ago

3.1.46

1 year ago

3.1.45

1 year ago

3.1.44

1 year ago

3.1.43

1 year ago

3.1.42

1 year ago

3.1.41

1 year ago

3.1.40

1 year ago

3.1.39

1 year ago

3.1.38

1 year ago

3.1.37

1 year ago

3.1.36

1 year ago

3.1.35

1 year ago

3.1.34

1 year ago

2.1.34

1 year ago

2.1.33

1 year ago

2.1.32

1 year ago

2.1.31

1 year ago

2.1.30

1 year ago

2.1.29

1 year ago

2.1.28

1 year ago

2.1.27

1 year ago

2.1.26

1 year ago

2.1.25

1 year ago

2.1.24

1 year ago

2.1.23

1 year ago

2.1.22

1 year ago

2.1.21

1 year ago

2.1.20

1 year ago

1.1.20

1 year ago

1.1.19

1 year ago

1.1.18

1 year ago

1.1.17

1 year ago

1.0.17

1 year ago

1.0.16

1 year ago

1.0.15

1 year ago

1.0.14

1 year ago

1.0.13

1 year ago

1.0.12

1 year ago

1.0.11

1 year ago

1.0.10

1 year ago

1.0.9

1 year ago

1.0.8

1 year ago

1.0.7

1 year ago

1.0.6

1 year ago

1.0.5

1 year ago

1.0.4

1 year ago

1.0.3

1 year ago

1.0.2

1 year ago

1.0.1

1 year ago

1.0.0

1 year ago