@@ -20,17 +20,52 @@ npm install @elastic/elasticsearch@<major>
2020To learn more about the supported major versions, please refer to the
2121<<js-compatibility-matrix>>.
2222
23+ [discrete]
24+ [[nodejs-support]]
25+ === Node.js support
26+
27+ NOTE: The minimum supported version of Node.js is `v8`.
28+
29+ The client versioning follows the {stack} versioning, this means that
30+ major, minor, and patch releases are done following a precise schedule that
31+ often does not coincide with the https://nodejs.org/en/about/releases/[Node.js release] times.
32+
33+ To avoid support insecure and unsupported versions of Node.js, the
34+ client *will drop the support of EOL versions of Node.js between minor releases*.
35+ Typically, as soon as a Node.js version goes into EOL, the client will continue
36+ to support that version for at least another minor release. If you are using the client
37+ with a version of Node.js that will be unsupported soon, you will see a warning
38+ in your logs (the client will start logging the warning with two minors in advance).
39+
40+ Unless you are *always* using a supported version of Node.js,
41+ we recommend defining the client dependency in your
42+ `package.json` with the `~` instead of `^`. In this way, you will lock the
43+ dependency on the minor release and not the major. (for example, `~7.10.0` instead
44+ of `^7.10.0`).
45+
46+ [%header,cols=3*]
47+ |===
48+ |Node.js Version
49+ |Node.js EOL date
50+ |End of support
51+
52+ |`8.x`
53+ |December 2019
54+ |`7.11` (early 2021)
55+
56+ |`10.x`
57+ |April 2021
58+ |`7.12` (mid 2021)
59+ |===
60+
2361[discrete]
2462[[js-compatibility-matrix]]
2563=== Compatibility matrix
2664
27- The minimum supported version of Node.js is `v8`.
28-
2965The library is compatible with all {es} versions since 5.x. We recommend you to
3066use the same major version of the client as the {es} instance that you are
3167using.
3268
33-
3469[%header,cols=2*]
3570|===
3671|{es} Version
5590
5691WARNING: There is no official support for the browser environment. It exposes
5792your {es} instance to everyone, which could lead to security issues. We
58- recommend you to write a lightweight proxy that uses this client instead.
93+ recommend you to write a lightweight proxy that uses this client instead.
0 commit comments