From b9ea8f8906965f32dc1fa14f9fea732540260247 Mon Sep 17 00:00:00 2001 From: Josh Mock Date: Mon, 6 May 2024 14:33:03 -0500 Subject: [PATCH] Add ES|QL helper note to changelog (#2249) --- docs/changelog.asciidoc | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/changelog.asciidoc b/docs/changelog.asciidoc index cb0ddb673..8c5b76c91 100644 --- a/docs/changelog.asciidoc +++ b/docs/changelog.asciidoc @@ -7,6 +7,12 @@ [discrete] ==== Features +[discrete] +===== ES|QL object API helper + +A helper method has been added that parses the response of an ES|QL query and converts it into an array of objects. +A TypeScript type parameter can also be provided to improve developer experience when working with the result. https://github.com/elastic/elasticsearch-js/pull/2238[#2238] + [discrete] ===== `onSuccess` callback added to bulk helper @@ -461,7 +467,7 @@ client.search({ params }, { options }, (err, result) => { client.search({ params }, { options }) .then(console.log) .catch(console.log) - + // async-style (sugar syntax on top of promises) const response = await client.search({ params }, { options }) console.log(response) @@ -621,7 +627,7 @@ If you weren't extending the internals of the client, this won't be a breaking c *Breaking: Yes* | *Migration effort: Medium* -Currently, every path or query parameter could be expressed in both `snake_case` and `camelCase`. Internally the client will convert everything to `snake_case`. +Currently, every path or query parameter could be expressed in both `snake_case` and `camelCase`. Internally the client will convert everything to `snake_case`. This was done in an effort to reduce the friction of migrating from the legacy to the new client, but now it no longer makes sense. If you are already using `snake_case` keys, this won't be a breaking change for you.