Skip to content

fix: Correctly type getMissingResultsUrl query as string#1781

Merged
shortcuts merged 1 commit into
algolia:mainfrom
askoufis:fix-prop-type
Feb 6, 2023
Merged

fix: Correctly type getMissingResultsUrl query as string#1781
shortcuts merged 1 commit into
algolia:mainfrom
askoufis:fix-prop-type

Conversation

@askoufis

@askoufis askoufis commented Feb 6, 2023

Copy link
Copy Markdown
Contributor

({ query: string }) => string; was being interpreted as a prop rename, which doesn't make sense in the context of an interface, so I've corrected it to what I assume was the intended outcome where query is of type string, rather than being inferred as any.

NOTE: Technically this is a breaking change as query was being inferred with type any, so consumers that were using it as such may need to change their code. On the other hand, I doubt many consumers are using this value as if it were anything but a string, so IMO a patch fix is also valid in this case. I'll leave this decision to the maintainers.

@netlify

netlify Bot commented Feb 6, 2023

Copy link
Copy Markdown

Deploy Preview for docsearch canceled.

Name Link
🔨 Latest commit 03d7e77
🔍 Latest deploy log https://app.netlify.com/sites/docsearch/deploys/63e0c7ae7ee4080009fed84b

@francoischalifour francoischalifour left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I think that's fine to release as a minor as it was not intended.

@shortcuts

Copy link
Copy Markdown
Member

oops thanks! indeed it was also provided in #1735 and not intended D:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants