-
Notifications
You must be signed in to change notification settings - Fork 85
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
MatchingStrategies
type issues
#1588
Labels
Comments
MatchingStrategies
re-implemented in instant-meilisearch
, because exported type is not very usefulMatchingStrategies
type issues
Good idea! Feel free to implement it, we are open to review your PR 😄 |
3 tasks
meili-bors bot
added a commit
that referenced
this issue
Oct 17, 2023
1593: Fix const enum issues r=brunoocasali a=jonespen # Pull Request ## Related issue Fixes #1588 ## What does this PR do? `const enum` is not really suited for libraries (ref https://youtu.be/jjMbPt_H3RQ?feature=shared&t=249 and https://www.typescriptlang.org/docs/handbook/enums.html#const-enum-pitfalls) and cause issues in typescript projects with `isolatedModules: true` (like Next.js). Instead, regular objects can be used (like done in #1350) with `as const` to make them type safe. About the `as readonly string[]` in cfcda4f, this could probably have been solved by a type guard as well, but I opted for the type cast option instead to avoid runtime code changes. ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! Co-authored-by: Jon Espen Kvisler <jonespen@gmail.com>
meili-bors bot
added a commit
that referenced
this issue
Oct 17, 2023
1593: Fix const enum issues r=brunoocasali a=jonespen # Pull Request ## Related issue Fixes #1588 ## What does this PR do? `const enum` is not really suited for libraries (ref https://youtu.be/jjMbPt_H3RQ?feature=shared&t=249 and https://www.typescriptlang.org/docs/handbook/enums.html#const-enum-pitfalls) and cause issues in typescript projects with `isolatedModules: true` (like Next.js). Instead, regular objects can be used (like done in #1350) with `as const` to make them type safe. About the `as readonly string[]` in cfcda4f, this could probably have been solved by a type guard as well, but I opted for the type cast option instead to avoid runtime code changes. ## PR checklist Please check if your PR fulfills the following requirements: - [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! Co-authored-by: Jon Espen Kvisler <jonespen@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I know this might sound like nitpicking, but I am trying to contribute, and this does cause a little issue.
I see that the instantsearch plugin even went so far as to re-implement the native enum into a typescript enum.
meilisearch-js/src/types/types.ts
Lines 57 to 62 in b9f3c6a
Should be re-written to:
Otherwise
MatchingStrategies
is juststring
.The text was updated successfully, but these errors were encountered: