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

Fix request typo and redeclare block-scoped variable 'response' (#1329)

Browse Source
This commit is contained in:
Subhendu Sethi
2020-10-05 13:04:31 +05:30
committed by GitHub
parent b8940533a9
commit aaeadee940
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/typescript.asciidoc
View File

@ -7,7 +7,7 @@ definitions for every exposed API.
NOTE: If you are using TypeScript you will be required to use _snake_case_ style NOTE: If you are using TypeScript you will be required to use _snake_case_ style
to define the API parameters instead of _camelCase_. to define the API parameters instead of _camelCase_.
By default event API uses https://www.typescriptlang.org/docs/handbook/generics.html[generics] to specify the requets and response bodies and the `meta.context`. Currently we can't provide those definitions, but we are working to improve this situation. By default event API uses https://www.typescriptlang.org/docs/handbook/generics.html[generics] to specify the requests and response bodies and the `meta.context`. Currently we can't provide those definitions, but we are working to improve this situation.
You can find a partial definition of the request types by importing `RequestParams`, which is used by default in the client and accepts a body (when needed) as a generic to provide a better specification. You can find a partial definition of the request types by importing `RequestParams`, which is used by default in the client and accepts a body (when needed) as a generic to provide a better specification.
@ -108,7 +108,7 @@ interface Source {
async function run () { async function run () {
// All of the examples below are valid code, by default, // All of the examples below are valid code, by default,
// the request body will be `RequestBody` and response will be `Record<string, any>`. // the request body will be `RequestBody` and response will be `Record<string, any>`.
const response = await client.search({ let response = await client.search({
index: 'test', index: 'test',
body: { body: {
query: { query: {
@ -120,7 +120,7 @@ async function run () {
console.log(response.body) console.log(response.body)
// The first generic is the response body // The first generic is the response body
const response = await client.search<SearchResponse<Source>>({ response = await client.search<SearchResponse<Source>>({
index: 'test', index: 'test',
// Here the body must follow the `RequestBody` interface // Here the body must follow the `RequestBody` interface
body: { body: {
@ -132,7 +132,7 @@ async function run () {
// body here is `SearchResponse<Source>` // body here is `SearchResponse<Source>`
console.log(response.body) console.log(response.body)
const response = await client.search<SearchResponse<Source>, SearchBody>({ response = await client.search<SearchResponse<Source>, SearchBody>({
index: 'test', index: 'test',
// Here the body must follow the `SearchBody` interface // Here the body must follow the `SearchBody` interface
body: { body: {