habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Better message in case of unsupported build flavor (#1498) (#1502)

Browse Source 
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2021-07-24 16:55:14 +02:00
committed by GitHub
parent e8b4eb8b9b
commit db5476ad5d
4 changed files with 159 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/installation.asciidoc
View File

@ -17,7 +17,7 @@ To install a specific major version of the client, run the following command:
npm install @elastic/elasticsearch@<major>
----
To learn more about the supported major versions, please refer to the
To learn more about the supported major versions, please refer to the
<<js-compatibility-matrix>>.
[discrete]
@ -37,7 +37,7 @@ to support that version for at least another minor release. If you are using the
with a version of Node.js that will be unsupported soon, you will see a warning
in your logs (the client will start logging the warning with two minors in advance).
Unless you are *always* using a supported version of Node.js,
Unless you are *always* using a supported version of Node.js,
we recommend defining the client dependency in your
`package.json` with the `~` instead of `^`. In this way, you will lock the
dependency on the minor release and not the major. (for example, `~7.10.0` instead
@ -62,9 +62,12 @@ of `^7.10.0`).
[[js-compatibility-matrix]]
=== Compatibility matrix
The library is compatible with all {es} versions since 5.x. We recommend you to
use the same major version of the client as the {es} instance that you are
using.
Elastic language clients are guaranteed to be able to communicate with Elasticsearch
or Elastic solutions running on the same major version and greater or equal minor version.
Language clients are forward compatible; meaning that clients support communicating
with greater minor versions of Elasticsearch. Elastic language clients are not
guaranteed to be backwards compatible.
[%header,cols=2*]
|===
@ -91,4 +94,4 @@ using.
WARNING: There is no official support for the browser environment. It exposes
your {es} instance to everyone, which could lead to security issues. We
recommend you to write a lightweight proxy that uses this client instead,
you can see a proxy example https://github.com/elastic/elasticsearch-js/tree/master/docs/examples/proxy[here].
you can see a proxy example https://github.com/elastic/elasticsearch-js/tree/master/docs/examples/proxy[here].