Skip to content

Commit 234d699

Browse files
committed
Exposed created MeiliSearch instance, re-exported all of "meilisearch" package.
1 parent 2bd6163 commit 234d699

File tree

4 files changed

+28
-0
lines changed

4 files changed

+28
-0
lines changed

.changeset/sharp-beds-lie.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
"@meilisearch/instant-meilisearch": minor
3+
---
4+
5+
- exposed created `MeiliSearch` instance
6+
- re-exported all of `"meilisearch"` package
7+
8+
These improvements make it so that no separate `"meilisearch"` package
9+
has to be installed in order to use its exports directly. This
10+
way a single `MeiliSearch` instance can be re-used, and we can potentially
11+
save on bundle size by avoiding a separate different version installation of
12+
`"meilisearch"`.
13+
14+
```typescript
15+
import { instantMeiliSearch, meilisearch } from '@meilisearch/instant-meilisearch'
16+
// re-exported "meilisearch" ^
17+
18+
const {
19+
meiliSearchInstance,
20+
// ^ re-usable MeiliSearch instance
21+
searchClient
22+
} = instantMeiliSearch(/*...*/)
23+
```

packages/instant-meilisearch/src/client/instant-meilisearch-client.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,9 @@ export function instantMeiliSearch(
7979
const instantMeilisearchConfig = getInstantMeilisearchConfig(
8080
instantMeiliSearchOptions
8181
)
82+
8283
return {
84+
meiliSearchInstance: meilisearchClient,
8385
setMeiliSearchParams: (params): void => {
8486
const { meiliSearchParams } = instantMeiliSearchOptions
8587
instantMeiliSearchOptions.meiliSearchParams =
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
export * from './client'
22
export * from './types'
3+
export * as meilisearch from 'meilisearch'

packages/instant-meilisearch/src/types/types.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import type {
77
MultiSearchQuery as MeiliSearchMultiSearchParams,
88
MultiSearchResult,
99
Config as MeilisearchConfig,
10+
MeiliSearch,
1011
} from 'meilisearch'
1112

1213
// Turns readonly types into mutable ones
@@ -127,6 +128,7 @@ export type InstantMeiliSearchInstance = SearchClient & {
127128
}
128129

129130
export type InstantMeiliSearchObject = {
131+
meiliSearchInstance: MeiliSearch
130132
setMeiliSearchParams: (params: OverridableMeiliSearchSearchParameters) => void
131133
searchClient: InstantMeiliSearchInstance
132134
}

0 commit comments

Comments
 (0)