Module that offers a variety of queries around npms
data.
$ npm install @npms/queries
For now, only queries related to search
are available. Though, the goal of this module is to provide other interesting queries in the near future, such as top ranked modules, top authors, etc.
Performs a search query.
Besides normal text, q
supports qualifiers to express filters and other modifiers.
The esClient
accepts a elasticsearch
instance or a config to instantiate it.
You may read the API docs to know which qualifiers are available.
const queries = require('@npms/queries');
// ...
queries.search('test framework', esClient)
.then((res) => {
console.log('total', res.total);
console.log('results', res.results);
});
Available options:
from
: The offset in which to start searching from, defaults to0
size
: The total number of results to return, defaults to25
throwOnInvalid
: Whether to reject the promise if the query has invalid qualifiers or not, defaults tofalse
(iffalse
, invalid qualifiers will be removed fromq
)
Fetch search suggestions to be typically displayed when doing autocomplete.
Only normal text is supported in q
but any qualifiers will be automatically discarded.
The esClient
accepts a elasticsearch
instance or a config to instantiate it.
const queries = require('@npms/queries');
// ...
queries.search.suggestions('gulp', esClient)
.then((suggestions) => console.log('suggestions', suggestions));
Available options:
size
: The total number of results to return, defaults to25
$ npm test
$ npm test-cov
to get coverage report
Released under the MIT License.