@spicy-hooks/utils

General utility functions and types

used within the @spicy-hooks project, but useful for other projects as well

While working a project you often end up with a bunch of utility functions (that you didn't find in lodash) somewhere in your repo. It feels like a waste of time and good code to always reinvent the wheel for each further project.

That's why we're publishing few utility functions and types we created for the @spicy-hooks project and hoping that people will add their own so that we can share them across the projects and eventually even across companies.

This package is a part of the @spicy-hooks family. Be sure to checkout the other interesting packages we offer.

Installation

Just use the usual way:

npm install @spicy-hooks/utils --save

or

yarn add @spicy-hooks/utils

Versioning

The whole @spicy-hooks project complies with Semantic Versioning. The @spicy-hooks/utils package is however just one package from the whole project. Seeing the major version incremented therefore doesn't necessarily mean that there is a breaking change in this particular package. Check the CHANGELOG.md for accurate information.

It is guaranteed though, that when the major version doesn't change, there has been no breaking change in this package.

Warning: The internal folder is excluded from any semantic versioning conventions. Importing from this folder directly is strongly discouraged.

Issues

Please submit any issue or feature request on the main project. (issue templates coming soon)

Documentation

• API reference - detailed description of every included utility function
• contribution guide - when you want to get involved