Incorrect form of @types/elasticsearch SearchResponse

Question

Incorrect form of @types/elasticsearch SearchResponse

Whenever I utilize the ElasticsearchService from @nestjs/elasticsearch, the response does not align with the type SearchResponse from @types/elasticsearch. The issue is that SearchResponse is supposed to be an object, but I actually receive an array containing both the SearchResponse object and an HTTP Status Code. Does anyone know how to disable this feature?

For instance:

[
  {
    ...,
    "aggregations": {
      "backendVersions": {
        "doc_count_error_upper_bound": 0,
        "sum_other_doc_count": 0,
        "buckets": [
          {
            "key": "1.0.0",
            "doc_count": 1
          }
        ]
      }
    }
  },
  200
]

typescript elasticsearch http-status-codes nestjs

Answer 1

Answer №1

The ElasticsearchService provided in @nestjs/elasticsearch wraps the Elasticsearch client with bindNodeCallback, as detailed in the documentation.

For example:

client.search({
  index: 'my-index',
  body: { foo: 'bar' }
}, (err, body, statusCode, headers) => {
  if (err) console.log(err)
})

This will be converted into an observable that emits a value with the arguments from the callback, excluding the error, in an array.

service.search({
  index: 'my-index',
  body: { foo: 'bar' }
}).subscribe(value => {
  console.log(value); // [body, statusCode, headers]
});

You cannot disable this functionality, but you have the option to use the Elasticsearch client directly by calling getClient():

const searchResponse = await service.getClient().search({
  index: 'my-index',
  body: { foo: 'bar' }
});

Additionally, please note that there may be breaking changes in @elastic/elasticsearch [7.x]:

client.search({
  index: 'my-index',
  body: { foo: 'bar' }
}, (err, { body, statusCode, headers, warnings }) => {
  if (err) console.log(err)
});

Answer 2

The ElasticsearchService provided in @nestjs/elasticsearch wraps the Elasticsearch client with bindNodeCallback, as detailed in the documentation.

For example:

client.search({
  index: 'my-index',
  body: { foo: 'bar' }
}, (err, body, statusCode, headers) => {
  if (err) console.log(err)
})

This will be converted into an observable that emits a value with the arguments from the callback, excluding the error, in an array.

service.search({
  index: 'my-index',
  body: { foo: 'bar' }
}).subscribe(value => {
  console.log(value); // [body, statusCode, headers]
});

You cannot disable this functionality, but you have the option to use the Elasticsearch client directly by calling getClient():

const searchResponse = await service.getClient().search({
  index: 'my-index',
  body: { foo: 'bar' }
});

Additionally, please note that there may be breaking changes in @elastic/elasticsearch [7.x]:

client.search({
  index: 'my-index',
  body: { foo: 'bar' }
}, (err, { body, statusCode, headers, warnings }) => {
  if (err) console.log(err)
});

Incorrect form of @types/elasticsearch SearchResponse

Answer №1

Similar questions

Unlocking the accordion feature in Ionic 3 form: A step-by-step guide

Troubles encountered while deploying NestJS and Socket.IO application on Heroku due to PORT issue

Securing Routes in React-Ionic app with Firebase Authentication Context

Ensuring data integrity by validating incoming data with TypeScript and Angular 2

Obtain the correct context within the callback

The Authorization header in POST and PATCH fetch requests is stripped by Typescript

Is emitting a side effect event acceptable within an RxJS pipe?

typescript error indicating a missing property that is expected to exist

Issue encountered during project upload due to deployment error

How do I import NPM modules in Angular 5 without using @types?

What is the best way to refresh the script located within the head tag of an index.html file in an Angular

Tips for using useState to update only the element that was clicked:

What is the significance of using interfaces in parentheses when assigning typescript types?

Error: Missing provider for HttpTestingController in Angular testing context

Tips for effectively sharing custom validators across different modules

Using react-confetti to create numerous confetti effects simultaneously on a single webpage

What is the best way to utilize *ngSwitchWhen in a TypeScript environment?

Issue encountered with Ionic and ssh2: process.binding is not supported

Does the ViewContainerRef for the Directive determine the element on which the directive is declared?

What prevents `console.log` from working within a button click event?