KVSearch

Overview

This lib is providing a way to filter an array of any kind of object. You can provide an array of field you would like to "index", or you can generate your own query.

Installation

1npm install @nexucis/kvsearch

Usage

1. Filter a list of object using a list of index

1import { KVSearch } from '@nexucis/kvsearch';
2
3const list = [
4    {
5        labels: { instance: 'demo.org', job: 'demo' },
6        scrapePool: 'scrapePool demo'
7    },
8    {
9        labels: { instance: 'k8s.org', job: 'constellation' },
10        scrapePool: 'galaxy'
11    }
12]
13const search = new KVSearch({
14    indexedKeys: [
15        'labels',
16        'scrapePool',
17    ],
18});
19search.filter('demo', list) // will match the first object
20search.filter('constellation', list) // won't match any object present in the list, since the attribute `labels.jop` is not indexed

Here the indexed list says:

• Since labels value is an object, then check if the pattern is matching a key in the object return by labels
• Same thing for scrapePool, excepting it returns a string, so the code won't loop other a list of key, it will just check if the value of scrapePool is matching the pattern

Note that the matching is using the lib @nexucis/fuzzy, so it's not an exact match used.

2. Filter a list of object using a list of index, with some regexp

1import { KVSearch } from '@nexucis/kvsearch';
2
3const list = [
4    {
5        labels: { instance: 'demo.org', job: 'demo' },
6        scrapePool: 'scrapePool demo'
7    },
8    {
9        labels: { instance: 'k8s.org', job: 'constellation' },
10        scrapePool: 'galaxy'
11    }
12]
13const search = new KVSearch({
14    indexedKeys: [
15        'labels',
16        ['labels', /.*/],
17        'scrapePool',
18    ],
19});
20search.filter('constel', list) // will match only the 2nd object

The difference here is we indexed the attributes of the labels object. In this example, by using the Regexp /.*/ we indexed every attribute of the object labels. That's why the pattern constellation is matching the second object. But we could also just index the field job of the labels like that ['labels', 'job']. It would have worked as well.

3. Filter a list of object using a specific query.

Using a list of index is simple, but it always used a fuzzy match. Probably sometimes you would like to do an exact match or a negative match depending on the context.

You can do it by creating your own query like that:

1import { KVSearch } from '@nexucis/kvsearch';
2
3const list = [
4    {
5        labels: { instance: 'demo.org', job: 'demo' },
6        scrapePool: 'scrapePool demo'
7    },
8    {
9        labels: { instance: 'k8s.org', job: 'constellation' },
10        scrapePool: 'galaxy'
11    }
12]
13const search = new KVSearch();
14search.filterWithQuery({ keyPath: ['labels', /.*/], match: 'exact', pattern: 'constellation' })

4. Filter a list of object using a complex query.

It's possible to combine query together, so you can write multiple conditions.

1import { KVSearch } from '@nexucis/kvsearch';
2
3const list = [
4    {
5        labels: { instance: 'demo.org', job: 'demo' },
6        scrapePool: 'scrapePool demo'
7    },
8    {
9        labels: { instance: 'k8s.org', job: 'constellation' },
10        scrapePool: 'galaxy'
11    },
12    {
13        labels: { instance: 'awx.com', job: 'constellation' },
14        scrapePool: 'galaxy',
15    }
16]
17const search = new KVSearch();
18search.filterWithQuery({
19    operator: 'and',
20    left: {
21        keyPath: ['scrapePool'],
22        match: 'fuzzy',
23        pattern: 'gal'
24    },
25    right: {
26        keyPath: ['labels', 'instance'],
27        match: 'exact',
28        pattern: 'awx.com'
29    }
30}) // this query is matching the last element of the list.

Note as it can be painful to write the query himself, a support to write it with a string in the codemirror editor is available. Check it here

Demo

A demo is available if you want to run it.

• you need node 16 and npm 8
• Clone the project
• at the root of the project, run npm install
• then run npm start

the demo should start with webpack and you can open your browser with the URL provided by webpack.

License

MIT