# @terrajs/mono-elasticsearch

> ElasticSearch module for Mono

Latest version **2.1.0** (published 2017-09-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install @terrajs/mono-elasticsearch
pnpm add @terrajs/mono-elasticsearch
yarn add @terrajs/mono-elasticsearch
bun add @terrajs/mono-elasticsearch
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2017-09-30 |
| First published | 2017-08-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Maintainers | gaetansenn, alexchopin, benjamincanac, atinux |
| Keywords | elasticsearch, mono, mono-elasticsearch |

## Links

- npm: https://www.npmjs.com/package/@terrajs/mono-elasticsearch
- Repository: https://github.com/terrajs/mono-elasticsearch
- Homepage: https://github.com/terrajs/mono-elasticsearch#readme
- Issues: https://github.com/terrajs/mono-elasticsearch/issues
- npm.io page: https://npm.io/package/@terrajs/mono-elasticsearch

## Dependencies (1)

- [elasticsearch](https://npm.io/package/elasticsearch.md) ^13.3.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 2.1.0 (latest) — 2017-09-30
- 2.0.0 — 2017-09-27
- 1.0.0 — 2017-08-11

## README

# mono-elasticsearch

ElasticSearch module for [Mono](https://github.com/terrajs/mono).

[![npm version](https://img.shields.io/npm/v/@terrajs/mono-elasticsearch.svg)](https://www.npmjs.com/package/@terrajs/mono-elasticsearch)
[![Travis](https://img.shields.io/travis/terrajs/mono-elasticsearch/master.svg)](https://travis-ci.org/terrajs/mono-elasticsearch)
[![Coverage](https://img.shields.io/codecov/c/github/terrajs/mono-elasticsearch/master.svg)](https://codecov.io/gh/terrajs/mono-elasticsearch.js)
[![license](https://img.shields.io/github/license/terrajs/mono-elasticsearch.svg)](https://github.com/terrajs/mono-elasticsearch/blob/master/LICENSE)

## Installation

```bash
npm install --save @terrajs/mono-elasticsearch
```

Then, in your configuration file of your Mono application (example: `conf/application.js`):

```js
module.exports = {
  mono: {
    modules: ['@terrajs/mono-elasticsearch']
  }
}
```

## Configuration

Mono-elasticsearch will use the `elasticsearch` property of your configuration (example: `conf/development.js`):

```js
module.exports = {
  mono: {
    elasticsearch: {
      // See https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/configuration.html
      host: 'localhost:9200'
    }
  }
}
```

## Usage

In your modules files, you can access `client` instance like this:

```js
const { client } = require('@terrajs/mono-elasticsearch')

client.ping({
  // ping usually has a 3000ms timeout
  requestTimeout: 1000
}, function (error) {
  if (error) {
    console.trace('elasticsearch cluster is down!');
  } else {
    console.log('All is well');
  }
});
```

---
_Source: https://npm.io/package/@terrajs/mono-elasticsearch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._