ElasticItems

Elasticsearch 7.x client for JS with faceted search, custom features and simple interface

Features

- faceted search
- full text
- pagination
- sorting

Getting Started

``bash
npm install elasticitems
`

`js
const elasticitems = require('elasticitems')(es_config, search_config);
elasticitems.search()
.then(result => {
console.log(result);
})
`

API

$3

#### es_config

The first es_config is elasticsearch configuration object and contains values like host, index or type.

#### search_config

Responsible for defining global configuration.

* aggregations filters configuration i.e. for tags, actors, colors, etc. Responsible for generating facets.

* sortings you can configure different sortings like tags_asc, tags_desc with options and later use it with one key.

$3

#### options

* per_page amount of items per page.

* page page number - used for pagination.

* query used for full text search.

* operator search operator and and or (default). It works with query parameter

* sort used for sorting. one of sortings key

* filters filtering items based on specific aggregations i.e. {tags: ['drama' , 'historical']}

* query_string i.e. "brand:Audi OR brand:Mercedes"

* facets_names make faceted search only for specific fields i.e. ['tags', 'genres']

* fields search only in specifc fields i.e. ['name', 'description']. Missing parameter means search in all fields

* ids search by ids i.e. ['1', '2', '3']

* exclude_ids exclude ids from search i.e. ['1', '2', '3']

$3

Show similar items based on collaborative filtering

#### options

* fields i.e ['tags'].

$3

It returns full list of filters for specific aggregation

#### options

* name aggregation name

* per_page filters per page

* size how much load into memory (for pagination)

* page page number

* sort responsible for sorting mechanism. It can be _count or _term

* order responsible for an order. It can be asc or desc

* filters filter this aggregation through another aggregations (facets)

* aggregation_query used for quering filters. It's not full text search

* query search through items

* query_string search through items by query string i.e. (category:Garden and color:red)



$3

Returns found record otherwise throw an error

$3

Returns record based on key and value

$3

Add a new object into index. Provide your own id if you don't want it auto-generated

$3

Updates object in index

$3

Delete object from index

$3

- Full text search does not work on keyword type because this type is not tokenized. keyword type is great for faceted fields

Tests

`
npm test
``