Skip to content

Commit

Permalink
Fix typo in README
Browse files Browse the repository at this point in the history
  • Loading branch information
kyarik committed Aug 31, 2020
1 parent df27264 commit e00b4ad
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Why this library exists?

There are many helpful functions that can make your code safer, such as `invariant` and `assertNever`. Many of these functions are available as separate npm packages (for example, [`invariant`](https://www.npmjs.com/package/invariant)). But installing a new package (and most of the time the `@types` counterpart as well) for each function is not very convinient. Also, those packages generally export their functions as default exports, making VSCode auto-import not work well with them.
There are many helpful functions that can make your code safer, such as `invariant` and `assertNever`. Many of these functions are available as separate npm packages (for example, [`invariant`](https://www.npmjs.com/package/invariant)). But installing a new package (and most of the time the `@types` counterpart as well) for each function is not very convenient. Also, those packages generally export their functions as default exports, making VSCode auto-import not work well with them.

This library unifies the functions that make you code safer into a single place. `circumspect` is a single dependency that has them all. And VSCode auto-import works as expected because all function provided by `circumspect` are named exports.

Expand Down

0 comments on commit e00b4ad

Please sign in to comment.