wowsearch-elastic-adaptor

wowsearch adaptor for elastic

Usage no npm install needed!

<script type="module">
  import wowsearchElasticAdaptor from 'https://cdn.skypack.dev/wowsearch-elastic-adaptor';
</script>

README

wowsearch-elastic-adaptor

NPM version NPM Downloads

wowsearch adaptor for elastic

区分 node 环境和 browser 环境适配器,node 环境适配器主要是将数据推送至 elasticsearch 远端,browser 适配器主要是为 wowsearch-ui 提供获取数据的方式。

Installation

npm install wowsearch-elastic-adaptor
# or use yarn
yarn add wowsearch-elastic-adaptor

Usage

wowsearch-elastic-adaptor/node

  • wowsearch config
source_adaptor: {
  "name": "wowsearch-elastic-adaptor/node",
  "options": {
    "endpoint": "https://example.elasticsearch.com"
    "index_name": "my_blog",
    // "url_tpl": ""
  }
}

wowsearch-elastic-adaptor/browser

import UI from 'wowsearch-ui'
import 'wowsearch-ui/index.less'
import adaptor from 'wowsearch-elastic-adaptor/browser'

ReactDOM.render(
  <UI {...adaptor({index_name: 'foo'})}/>
  // ...
)

API

wowsearch-elastic-adaptor/node

index_name

elasticsearch 的索引名

endpoint

elasticsearch 的服务端地址

  • Default: process.env.WOWSEARCH_ELASTIC_ADAPTOR_ENDPOINT || 'http://localhost:9200/'

url_tpl

拼凑某数据节点完整地址的模板,一般在使用 hash 路由的站点,需要设置为 '${url}'

  • Default: '${url}#${anchor}'

wowsearch-elastic-adaptor/browser

index_name

同上

endpoint

同上

data

额外外注入的请求数据,一般不需要用到

size

搜索条目的大小,默认 10

filters

额外的搜索条件,如 { lang: 'zh' } 来搜索中文环境

Authors

This library is written and maintained by imcuttle, <a href="mailto:moyuyc95@gmail.com"">moyuyc95@gmail.com.

License

MIT