\n\n## Description\n\nOpenSearch module for [Nest](https://github.com/nestjs/nest) based on the official [@opensearch-project/opensearch](https://www.npmjs.com/package/@opensearch-project/opensearch) package.\n\n## Installation\n\n```bash\n$ npm i --save @bytebitlabs/nest-opensearch @opensearch-project/opensearch\n```\n\n## Usage\n\nImport `OpenSearchModule`:\n\n```typescript\n@Module({\n imports: [OpenSearchModule.register({\n node: 'http://localhost:9200',\n })],\n providers: [...],\n})\nexport class SearchModule {}\n```\n\nInject `OpenSearchService`:\n\n```typescript\n@Injectable()\nexport class SearchService {\n constructor(private readonly openSearchService: OpenSearchService) {}\n}\n```\n\n## Async options\n\nQuite 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.\n\n**1. Use factory**\n\n```typescript\nOpenSearchModule.registerAsync({\n useFactory: () => ({\n node: 'http://localhost:9200'\n })\n});\n```\n\nObviously, our factory behaves like every other one (might be `async` and is able to inject dependencies through `inject`).\n\n```typescript\nOpenSearchModule.registerAsync({\n imports: [ConfigModule],\n useFactory: async (configService: ConfigService) => ({\n node: configService.get('OPENSEARCH_NODE'),\n }),\n inject: [ConfigService],\n}),\n```\n\n**2. Use class**\n\n```typescript\nOpenSearchModule.registerAsync({\n useClass: OpenSearchConfigService\n});\n```\n\nAbove construction will instantiate `OpenSearchConfigService` inside `OpenSearchModule` and will leverage it to create options object.\n\n```typescript\nclass OpenSearchConfigService implements OpensearchOptionsFactory {\n createOpensearchOptions(): OpenSearchModuleOptions {\n return {\n node: 'http://localhost:9200'\n };\n }\n}\n```\n\n**3. Use existing**\n\n```typescript\nOpenSearchModule.registerAsync({\n imports: [ConfigModule],\n useExisting: ConfigService,\n}),\n```\n\nIt works the same as `useClass` with one critical difference - `OpenSearchModule` will lookup imported modules to reuse already created `ConfigService`, instead of instantiating it on its own.\n\n## API Spec\n\nThe `OpenSearchService` wraps the `Client` from the official [@opensearch-project/opensearch](https://www.npmjs.com/package/@opensearch-project/opensearch) methods. The `OpenSearchModule.register()` takes `options` object as an argument, [read more](https://opensearch.org/docs/latest/clients/javascript/index).\n","readmeFilename":"README.md"}
![\"ByteBitLabs](\"https://gravatar.com/avatar/61c80d73dfe4c4231e77940cf80fd410?size=256\")
![\"NPM](\"https://img.shields.io/npm/v/@bytebitlabs/nest-opensearch\")
![\"Package](\"https://img.shields.io/npm/l/@bytebitlabs/nest-opensearch\")
![\"NPM](\"https://img.shields.io/npm/dm/@bytebitlabs/nest-opensearch\")