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

docs: fix the usage of history.listen #8718

Merged
merged 1 commit into from Mar 15, 2022
Merged

docs: fix the usage of history.listen #8718

merged 1 commit into from Mar 15, 2022

Conversation

ThornWu
Copy link
Contributor

@ThornWu ThornWu commented Mar 15, 2022

history.listen accepts two parameters in the preceding document: location and action.

However, I discovered the type declaration below while reading the docs of history. Instead of two parameters, history.listen allows one parameter with two properties.

interface Listener {
  (update: Update): void;
}

interface Update {
  action: Action;
  location: Location;
}

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 15, 2022

Hi @ThornWu,

Welcome, and thank you for contributing to React Router!

Before we consider your pull request, we ask that you sign our Contributor License Agreement (CLA). We require this only once.

You may review the CLA and sign it by adding your name to contributors.yml.

Once the CLA is signed, the CLA Signed label will be added to the pull request.

If you have already signed the CLA and received this response in error, or if you have any questions, please contact us at hello@remix.run.

Thanks!

- The Remix team

@remix-cla-bot
Copy link
Contributor

remix-cla-bot bot commented Mar 15, 2022

Thank you for signing the Contributor License Agreement. Let's get this merged! 🥳

@timdorr
Copy link
Member

timdorr commented Mar 15, 2022

Thanks!

@timdorr timdorr merged commit 3ccfe53 into remix-run:main Mar 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants