Skip to content

Commit

Permalink
Exposed created MeiliSearch instance, re-exported all of "meilisearch…
Browse files Browse the repository at this point in the history
…" package.
  • Loading branch information
flevi29 committed Dec 17, 2023
1 parent 2bd6163 commit 234d699
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .changeset/sharp-beds-lie.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
"@meilisearch/instant-meilisearch": minor
---

- exposed created `MeiliSearch` instance
- re-exported all of `"meilisearch"` package

These improvements make it so that no separate `"meilisearch"` package
has to be installed in order to use its exports directly. This
way a single `MeiliSearch` instance can be re-used, and we can potentially
save on bundle size by avoiding a separate different version installation of
`"meilisearch"`.

```typescript
import { instantMeiliSearch, meilisearch } from '@meilisearch/instant-meilisearch'
// re-exported "meilisearch" ^

const {
meiliSearchInstance,
// ^ re-usable MeiliSearch instance
searchClient
} = instantMeiliSearch(/*...*/)
```
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,9 @@ export function instantMeiliSearch(
const instantMeilisearchConfig = getInstantMeilisearchConfig(
instantMeiliSearchOptions
)

return {
meiliSearchInstance: meilisearchClient,
setMeiliSearchParams: (params): void => {
const { meiliSearchParams } = instantMeiliSearchOptions
instantMeiliSearchOptions.meiliSearchParams =
Expand Down
1 change: 1 addition & 0 deletions packages/instant-meilisearch/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
export * from './client'
export * from './types'
export * as meilisearch from 'meilisearch'
2 changes: 2 additions & 0 deletions packages/instant-meilisearch/src/types/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import type {
MultiSearchQuery as MeiliSearchMultiSearchParams,
MultiSearchResult,
Config as MeilisearchConfig,
MeiliSearch,
} from 'meilisearch'

// Turns readonly types into mutable ones
Expand Down Expand Up @@ -127,6 +128,7 @@ export type InstantMeiliSearchInstance = SearchClient & {
}

export type InstantMeiliSearchObject = {
meiliSearchInstance: MeiliSearch
setMeiliSearchParams: (params: OverridableMeiliSearchSearchParameters) => void
searchClient: InstantMeiliSearchInstance
}
Expand Down

0 comments on commit 234d699

Please sign in to comment.