Socket
Socket
Sign inDemoInstall

generic-matcher

Package Overview
Dependencies
7
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    generic-matcher

General purpose generic matcher


Version published
Weekly downloads
0
decreased by-100%
Maintainers
1
Created
Weekly downloads
 

Readme

Source

generic matcher

This tiny and fast module allows you to perform matching operations in any kind of generic data, provided as an array of objects. The module cleans the accents and the special characters and tries to perform an exact or partial match and returns the results back.

Install

You can install with [npm]:

$ npm install --save generic-matcher

Usage

The module requires to call the loadData function before any match operation is performed. The minimum parameters required are the data and match fields:


const genericMatcher = require('generic-matcher')
genericMatcher.loadData({data: <data_here>, match: <field_to_match_here>})

Once the data is loaded you can call the match method:


genericMatcher.match(<your_query_here>)

Please look at the index.test.js file to see a real example using a tiny movie database.

Running tests

You can run the tests and check the functionality of this module using:

$ npm install && npm test

License

Copyright © 2021, Juan Convers. Released under the MIT License.

Keywords

FAQs

Last updated on 25 Aug 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc