@iplatformglobal/array-multi-filter

Array Multi Filter

Array helper for filtering against multiple keys in an array of objects

Instalation

yarn add @iplatformglobal/array-multi-filter or

or

npm install @iplatformglobal/array-multi-filter

Usage

Filter an array of objects against multiple keys and values

// Data to be filtered
const arr = [{
  id: 1,
  distance: 100,
  name: 'test',
}, {
  id: 1,
  distance: 100,
  name: 'rest',
}];

// Keys and Values needing to be filtered against
const query = { distance: 100, name: 'test' };

arr.filter(arrayMultiFilter, query);

Testing

Testing is handled by Jest and the packages has the following commands setup

• yarn test
• yarn test:watch

Contributing

All contributions are welcome, and can be done by cloning the repo and running yarn install.

Ensure there are no errors in the tests or linter and ensure your commit messages comply to the following format:

• break: COMMIT_MSG - Changing the code in a way that changes the other users would need to implement it.
• feat: COMMIT_MSG - adding a new feature or capability to the helper.
• fix: COMMIT_MSG - any bugs or minor updates that fixes the existing code without adding or removing any capabilities.
• none: COMMIT_MSG - used for simple updates like documentation, aka NO code has changed.

There are git hooks configured to ensure commit message format as well as test and linter compliance

History

Discover the release history by heading on over to the releases page.

License

Unless stated otherwise all works are:

• Copyright © 2017+ iPlatform

and licensed under:

• MIT License