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

Docs: Fix typo and added a note

Browse Source
This commit is contained in:
delvedor
2019-02-14 16:25:03 +01:00
parent 6d68d22e32
commit 9bbae42ccc
2 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/typescript.asciidoc
View File

@ -2,7 +2,7 @@
The client offers a first-class support for TypeScript, since it ships the type definitions for every exposed API.
While the client offers tyoe definitions for Request parameters, Request bodies and responses are shipped with `any` because there is not an official spec that defines them, so we cannot make guarantees over them (but since they are shipped with `any`, you can easily override them with your own typing definitions).
While the client offers type definitions for Request parameters, Request bodies and responses are shipped with `any` because there is not an official spec that defines them, so we cannot make guarantees over them (but since they are shipped with `any`, you can easily override them with your own typing definitions).
NOTE: If you are using TypeScript you will be required to use _snake_case_ style to define the API parameters instead of _camelCase_.

2
docs/usage.asciidoc
View File

@ -34,6 +34,8 @@ The returned value of every API call is formed as follows:
}
----
NOTE: The body will be a boolean value when using `HEAD` APIs.
The above valiue will be returned even if there is an error during the execution of the request, this means that you can safely use the https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment[destructuring assignment].
[source,js]