Nest - modern, fast, powerful node.js web framework (@elasticsearch)


stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
Minified + gzip package size for @nestjs/elasticsearch in KB


Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads Travis Linux Coverage Discord Backers on Open Collective Sponsors on Open Collective


Elasticsearch module for Nest based on the official @elastic/elasticsearch package.


$ npm i --save @nestjs/elasticsearch @elastic/elasticsearch


Import ElasticsearchModule:

  imports: [ElasticsearchModule.register({
    node: 'localhost:9200',
  providers: [...],
export class SearchModule {}

Inject ElasticsearchService:

export class SearchService {
  constructor(private readonly elasticsearchService: ElasticsearchService) {}

Async options

Quite often you might want to asynchronously pass your module options instead of passing them beforehand. In such case, use registerAsync() method, that provides a couple of various ways to deal with async data.

1. Use factory

  useFactory: () => ({
    node: 'localhost:9200'

Obviously, our factory behaves like every other one (might be async and is able to inject dependencies through inject).

  imports: [ConfigModule],
  useFactory: async (configService: ConfigService) => ({
    node: configService.getString('ELASTICSEARCH_NODE'),
  inject: [ConfigService],

2. Use class

  useClass: ElasticsearchConfigService

Above construction will instantiate ElasticsearchConfigService inside ElasticsearchModule and will leverage it to create options object.

class ElasticsearchConfigService implements ElasticsearchOptionsFactory {
  createElasticsearchOptions(): ElasticsearchModuleOptions {
    return {
      node: 'localhost:9200'

3. Use existing

  imports: [ConfigModule],
  useExisting: ConfigService,

It works the same as useClass with one critical difference - ElasticsearchModule will lookup imported modules to reuse already created ConfigService, instead of instantiating it on its own.

API Spec

The ElasticsearchService wraps the Client from the official @elastic/elasticsearch methods. The ElasticsearchModule.register() takes options object as an argument, read more.


Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch


Nest is MIT licensed.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.