Skip to content
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

Spell success properly #1254

Merged
merged 1 commit into from
Mar 2, 2021
Merged

Conversation

greg0ire
Copy link
Contributor

Warning: I'm not a JS developer so I have no idea if there might be BC-breaks in this PR or not. I also don't know if this might actually fix any bug, hence why I picked refactor here.

@codesandbox-ci
Copy link

codesandbox-ci bot commented Feb 26, 2021

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 07dcc12:

Sandbox Source
javascript-client-app Configuration

@Haroenv
Copy link
Contributor

Haroenv commented Mar 1, 2021

hi @greg0ire, thanks a lot for this PR, but as you guessed it, this would be a breaking change for those who write a custom requester today. It would be possible to alias it to the correct name, and accept both wrong and correct spelling, or to add a comment // @MAJOR: replace with onSuccess so this can be changed in a next major version

@greg0ire
Copy link
Contributor Author

greg0ire commented Mar 1, 2021

It would be possible to alias it to the correct name, and accept both wrong and correct spelling

Is there a standard way in JS to trigger a deprecation when a call is performed with the wrong spelling?

@Haroenv
Copy link
Contributor

Haroenv commented Mar 1, 2021

No, there's no standard way of that, it would be calling the previous function and adding a log. At the moment for the sake of avoiding a major change for just this, I'd be edging on the side of having just a comment for now

@Haroenv Haroenv merged commit 173f5f1 into algolia:master Mar 2, 2021
@greg0ire greg0ire deleted the spell-success-properly branch March 2, 2021 15:07
This was referenced Mar 10, 2021
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.

None yet

2 participants