The problem

I do a bunch of open source and want to make it easier to share utilities between multiple projects.

This solution

This is a collection of javascript functions, utilities and react hooks that are available on npm.

Table of Contents

• The problem
• This solution
• Table of Contents
• Installation
• Usage
• Functions
• React Hooks
• Utils
• Tests
• Other Solutions
• Issues
  • 🐛 Bugs
  • 💡 Feature Requests
• Contributors ✨
• LICENSE

Installation

This module is distributed via npm which is bundled with node and should be installed as one of your project's dependencies:

npm install --save-dev @feedzai/js-utilities

Usage

This is a collection of functions, utilities and react hooks. You'll find all available code in src.

The bundle is available as:

• ES Modules
• UMD (Universal Module Definition)

To import a piece of code into your javascript project just do:

import { callIfExists, throwError, getLSItem, useConstant } from "@feedzai/js-utilities";

Functions

WIP

React Hooks

WIP

Utils

WIP

Tests

All tests have been written using cypress.

To run tests locally:

# using npm
npm run test:open

# using npm (headless)
npm run test

# using yarn
yarn test:open

# using yarn (headless)
yarn test

Other Solutions

If you are aware of any please make a pull request and add it here! Again, this is a very specific-to-me solution.

• Lightdash - A small JavaScript utility library to complement lodash.
• You might not need lodash - It’s a great website, well crafted, battle tested and with a very skilled and active community contributing. The goal of that project is NOT to provide drop in replacements, but to show how to achieve similar functionalities in plain Javascript, to understand how things work behind the hood.

Issues

Looking to contribute? Look for the Good First Issue label.

🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

See Bugs

💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

See Feature Requests

Contributors ✨

This project follows the all-contributors specification. Contributions of any kind welcome!

LICENSE

MIT