A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.
Description
Elasticsearch module for Nest based on the official elasticsearch package.
Installation
$ npm i --save @nestjs/elasticsearch elasticsearch @types/elasticsearch
Usage
Import ElasticsearchModule
:
@Module({
imports: [ElasticsearchModule.register({
host: 'localhost:9200',
log: 'trace',
})],
providers: [...],
})
export class SearchModule {}
Inject ElasticsearchService
:
@Injectable()
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
ElasticsearchModule.registerAsync({
useFactory: () => ({
host: 'localhost:9200',
log: 'trace',
}),
})
Obviously, our factory behaves like every other one (might be async
and is able to inject dependencies through inject
).
ElasticsearchModule.registerAsync({
imports: [ConfigModule],
useFactory: async (configService: ConfigService) => ({
host: configService.getString('ELASTICSEARCH_HOST'),
log: 'trace',
}),
inject: [ConfigService],
}),
2. Use class
ElasticsearchModule.registerAsync({
useClass: ElasticsearchConfigService,
})
Above construction will instantiate ElasticsearchConfigService
inside ElasticsearchModule
and will leverage it to create options object.
class ElasticsearchConfigService implements ElasticsearchOptionsFactory {
createElasticsearchOptions(): ElasticsearchModuleOptions {
return {
host: 'localhost:9200',
log: 'trace',
};
}
}
3. Use existing
ElasticsearchModule.registerAsync({
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
exposes native elasticsearch methods and wraps them in the Observable, read more. The ElasticsearchModule.register()
takes options
object as an argument, read more.
Support
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
License
Nest is MIT licensed.