22
33# Elasticsearch Node.js client
44
5- [ ![ js-standard-style] ( https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat )] ( http://standardjs.com/ ) [ ![ Build Status] ( https://badge.buildkite.com/15e4246eb268ea78f6e10aa90bce38c1abb0a4489e79f5a0ac.svg )] ( https://buildkite.com/elastic/elasticsearch-javascript-client-integration-tests/builds?branch=main ) [ ![ Node CI] ( https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg )] ( https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml ) [ ![ codecov] ( https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg )] ( https://codecov.io/gh/elastic/elasticsearch-js ) [ ![ NPM downloads] ( https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat )] ( https://www.npmjs.com/package/@elastic/elasticsearch )
5+ [ ![ js-standard-style] ( https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat )] ( http://standardjs.com/ ) [ ![ Build Status] ( https://badge.buildkite.com/15e4246eb268ea78f6e10aa90bce38c1abb0a4489e79f5a0ac.svg )] ( https://buildkite.com/elastic/elasticsearch-javascript-client-integration-tests/builds?branch=main ) [ ![ Node CI] ( https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml/badge.svg )] ( https://github.com/elastic/elasticsearch-js/actions/workflows/nodejs.yml ) [ ![ codecov] ( https://codecov.io/gh/elastic/elasticsearch-js/branch/master/graph/badge.svg )] ( https://codecov.io/gh/elastic/elasticsearch-js ) [ ![ NPM downloads] ( https://img.shields.io/npm/dm/@elastic/elasticsearch.svg?style=flat )] ( https://www.npmjs.com/package/@elastic/elasticsearch )
66
77** [ Download the latest version of Elasticsearch] ( https://www.elastic.co/downloads/elasticsearch ) **
88or
@@ -34,25 +34,26 @@ the new features of the 8.13 version of Elasticsearch, the 8.13 client version
3434is required for that. Elasticsearch language clients are only backwards
3535compatible with default distributions and without guarantees made.
3636
37- | Elasticsearch Version | Elasticsearch-JS Branch | Supported |
38- | --------------------- | ------------------------ | --------- |
39- | main | main | |
40- | 8.x | 8.x | 8.x |
41- | 7.x | 7.x | 7.17 |
37+ | Elasticsearch Version | Elasticsearch-JS Branch |
38+ | --------------------- | ----------------------- |
39+ | main | main |
40+ | 9.x | 9.x |
41+ | 8.x | 8.x |
42+ | 7.x | 7.x |
4243
4344## Usage
4445
45- * [ Creating an index] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index )
46- * [ Indexing a document] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_indexing_documents )
47- * [ Getting documents] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_getting_documents )
48- * [ Searching documents] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_searching_documents )
49- * [ Updating documents] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_updating_documents )
50- * [ Deleting documents] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_documents )
51- * [ Deleting an index] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_an_index )
46+ - [ Creating an index] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_creating_an_index )
47+ - [ Indexing a document] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_indexing_documents )
48+ - [ Getting documents] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_getting_documents )
49+ - [ Searching documents] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_searching_documents )
50+ - [ Updating documents] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_updating_documents )
51+ - [ Deleting documents] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_documents )
52+ - [ Deleting an index] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/getting-started-js.html#_deleting_an_index )
5253
5354### Node.js support
5455
55- NOTE: The minimum supported version of Node.js is ` v18 ` .
56+ NOTE: The minimum supported version of Node.js is ` v20 ` .
5657
5758The client versioning follows the Elastic Stack versioning, this means that
5859major, minor, and patch releases are done following a precise schedule that
@@ -65,58 +66,43 @@ to support that version for at least another minor release. If you are using the
6566with a version of Node.js that will be unsupported soon, you will see a warning
6667in your logs (the client will start logging the warning with two minors in advance).
6768
68- Unless you are ** always** using a supported version of Node.js,
69+ Unless you are ** always** using a supported version of Node.js,
6970we recommend defining the client dependency in your
7071` package.json ` with the ` ~ ` instead of ` ^ ` . In this way, you will lock the
7172dependency on the minor release and not the major. (for example, ` ~7.10.0 ` instead
7273of ` ^7.10.0 ` ).
7374
74- | Node.js Version | Node.js EOL date | End of support |
75- | --------------- | ------------------| ---------------------- |
76- | ` 8.x ` | ` December 2019 ` | ` 7.11 ` (early 2021) |
77- | ` 10.x ` | ` April 2021 ` | ` 7.12 ` (mid 2021) |
78- | ` 12.x ` | ` April 2022 ` | ` 8.2 ` (early 2022) |
79- | ` 14.x ` | ` April 2023 ` | ` 8.8 ` (early 2023) |
80- | ` 16.x ` | ` September 2023 ` | ` 8.11 ` (late 2023) |
81-
82- ### Compatibility
83-
84- Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch.
85- Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
86-
87- | Elasticsearch Version | Client Version |
88- | --------------------- | ----------------|
89- | ` 8.x ` | ` 8.x ` |
90- | ` 7.x ` | ` 7.x ` |
91- | ` 6.x ` | ` 6.x ` |
92- | ` 5.x ` | ` 5.x ` |
93-
94- To install a specific major of the client, run the following command:
95- ```
96- npm install @elastic/elasticsearch@<major>
97- ```
75+ | Node.js Version | Node.js EOL date | End of support |
76+ | --------------- | ---------------- | ------------------- |
77+ | ` 8.x ` | ` December 2019 ` | ` 7.11 ` (early 2021) |
78+ | ` 10.x ` | ` April 2021 ` | ` 7.12 ` (mid 2021) |
79+ | ` 12.x ` | ` April 2022 ` | ` 8.2 ` (early 2022) |
80+ | ` 14.x ` | ` April 2023 ` | ` 8.8 ` (early 2023) |
81+ | ` 16.x ` | ` September 2023 ` | ` 8.11 ` (late 2023) |
82+ | ` 18.x ` | ` April 2025 ` | ` 9.1 ` (mid 2025) |
9883
9984#### Browser
10085
10186> [ !WARNING]
10287> There is no official support for the browser environment. It exposes your Elasticsearch instance to everyone, which could lead to security issues.
103- We recommend that you write a lightweight proxy that uses this client instead, you can see a proxy example [ here] ( ./docs/examples/proxy ) .
88+ > We recommend that you write a lightweight proxy that uses this client instead, you can see a proxy example [ here] ( ./docs/examples/proxy ) .
10489
10590## Documentation
10691
107- * [ Introduction] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html )
108- * [ Usage] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#client-usage )
109- * [ Client configuration] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-configuration.html )
110- * [ API reference] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html )
111- * [ Authentication] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication )
112- * [ Observability] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html )
113- * [ Creating a child client] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/child.html )
114- * [ Client helpers] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html )
115- * [ Typescript support] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html )
116- * [ Testing] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-testing.html )
117- * [ Examples] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/examples.html )
92+ - [ Introduction] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/introduction.html )
93+ - [ Usage] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#client-usage )
94+ - [ Client configuration] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-configuration.html )
95+ - [ API reference] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/api-reference.html )
96+ - [ Authentication] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-connecting.html#authentication )
97+ - [ Observability] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/observability.html )
98+ - [ Creating a child client] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/child.html )
99+ - [ Client helpers] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-helpers.html )
100+ - [ Typescript support] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/typescript.html )
101+ - [ Testing] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/client-testing.html )
102+ - [ Examples] ( https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/examples.html )
118103
119104## Install multiple versions
105+
120106If you are using multiple versions of Elasticsearch, you need to use multiple versions of the client. In the past, install multiple versions of the same package was not possible, but with ` npm v6.9 ` , you can do that via aliasing.
121107
122108The command you must run to install different version of the client is:
@@ -161,7 +147,7 @@ client7.info().then(console.log, console.log)
161147```
162148
163149Finally, if you want to install the client for the next version of Elasticsearch
164- * (the one that lives in Elasticsearch’s main branch)* , you can use the following
150+ _ (the one that lives in Elasticsearch’s main branch)_ , you can use the following
165151command:
166152
167153``` sh
0 commit comments