https://github.com/lambrohan/nestjs-meilisearch
Meilisearch module for nestjs applications.
https://github.com/lambrohan/nestjs-meilisearch
meilisearch nestjs
Last synced: 2 months ago
JSON representation
Meilisearch module for nestjs applications.
- Host: GitHub
- URL: https://github.com/lambrohan/nestjs-meilisearch
- Owner: lambrohan
- License: mit
- Created: 2021-04-26T18:26:03.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-09T07:52:48.000Z (4 months ago)
- Last Synced: 2025-04-02T08:44:13.379Z (2 months ago)
- Topics: meilisearch, nestjs
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/nestjs-meilisearch
- Size: 383 KB
- Stars: 24
- Watchers: 1
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## About
This package is a simple wrapper around [meilisearch-js](https://github.com/meilisearch/meilisearch-js).
## Installation
This package requires `meilisearch` dependency to work properly.
```bash
yarn add nestjs-meilisearch meilisearch
```
## Getting Started
The simplest way to use `nestjs-meilisearch` is to use `MeiliSearchModule.forRoot` or `MeiliSearchModule.forRootAsync`
```typescript
import { Module } from '@nestjs-common';
import { MeiliSearchModule } from 'nestjs-meilisearch';
@Module({
imports: [
MeiliSearchModule.forRoot({
host: 'http://127.0.0.1:7700',
apiKey: 'masterKey',
}),
],
// or async
MeiliSearchModule.forRootAsync({
useFactory: () => ({
host: 'http://127.0.0.1:7700',
apiKey: 'masterKey',
}),
}),
})
export class AppModule {}
```
use `@InjectMeiliSearch()` decorator in any injectables to get a `MeiliSearch` client inside class
```typescript
import { Injectable } from '@nestjs/common';
import { InjectMeiliSearch } from 'nestjs-meilisearch';
import { MeiliSearch } from 'meilisearch';
@Injectable()
export class TestService {
public constructor(
@InjectMeiliSearch() private readonly meiliSearch: MeiliSearch,
) {}
}
```
You can also use `MeiliSearchService` to `add`,`update` and `delete` documents. I'm planning to add further operations to this service.
## License
Distributed under the MIT License. See `LICENSE` for more information.