How to use typescript mapping for ElasticSearch response?

Question

How do I set the Post SearchResult interface to the search return value

I can't set the interface to get the return results You can review the code below

dependencies

   "@nestjs/elasticsearch": "^8.1.0",
   "@elastic/elasticsearch": "^8.2.1",
   "@types/elasticsearch": "^5.0.40",

interface Post

export interface PostSearchResultInterface {
    hits: {
        total: {
            value: number;
        };
        hits: Array<{
            total: {
                value: number;
            }
            _source: PostSearchBodyInterface;
        }>;
    };
}

code

     const  search  = await this.elasticsearchService.search<PostSearchBodyInterface>({
                index: this.index,
                from: offset,
                size: limit,
                body: {
                    query: {
                        bool: {
                            should: {
                                multi_match: {
                                    query: text,
                                    fields: ['title', 'story', 'other_titles']
                                }
                            },
                            filter: {
                                range: {
                                    id: {
                                        gte: startId
                                    }
                                }
                            }
                        },
                    },
                    sort: {
                        id: {
                            order: 'asc'
                        }
                    }
                }
            }) ;


             // error here 
            let count = search.hits.total.value
           
            const hits = search.hits.hits;
            const results = hits.map((item) => item._source);
            return {
                count : startId ? separateCount : count,
                results
            }

error TS2339: Property 'value' does not exist on type 'number | SearchTotalHits'. Property 'value' does not exist on type 'number'.

ERROR: let count = search.hits.total.value

are you sure that elasticsearch is not reurning any error in response and search is returning 200 response code ? — Sagar Patel
– Sagar Patel, Commented Jul 4, 2022 at 5:38
yes if i skip the interface it's run but it's not recognize interface — Kareem Adel
– Kareem Adel, Commented Jul 4, 2022 at 5:47

Thierry Falvo · Accepted Answer · 2022-07-04 06:57:21Z

5

Assuming dependencies are (as question posted) :

"@nestjs/elasticsearch": "^8.1.0",
"@elastic/elasticsearch": "^8.2.1",
"@types/elasticsearch": "^5.0.40",

First, create a dedicated type for the indexed document, for example :

export type Document = { 
  title: string, 
  tags: string[]
};

Then, simply search for documents :

const a = await this.elastic.search<Document>({ //...request... });

const total = a.hits.total;
const documents = a.hits.hits.map(document => {
  // query metadata fields returned by elastic
  document._id;

  // get fields for <Document> type
  document._source.title...
  document._source.tags...
})

answered Jul 4, 2022 at 6:57

Thierry Falvo

6,3202 gold badges25 silver badges40 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to use typescript mapping for ElasticSearch response?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related