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

Ensure 2.1.0 features are in docs #4118

Closed
EskiMojo14 opened this issue Jan 24, 2024 · 2 comments
Closed

Ensure 2.1.0 features are in docs #4118

EskiMojo14 opened this issue Jan 24, 2024 · 2 comments
Labels

Comments

@EskiMojo14
Copy link
Collaborator

some of the features added in v2.1.0 are currently undocumented - need adding to docs

@riqts
Copy link
Contributor

riqts commented Jan 31, 2024

Would love to jump in and document these.

Do you know off the top of your head which of these changes from 2.1.0 post have/have not been updated?

I am happy to do my own research on the actual workings and what changed for the documentation update, but a small nudge in the right direction might be useful.

  • adds withTypes methods to listenerMiddleware and createDraftSafeSelector
  • adds a skipPollingIfUnfocused option to RTK Query
  • adds the ability to customise the createSelector instance used by RTK Query
  • reworks slice selector logic to avoid depending on this value (does this need documentation on the site?)
  • fixes the order and inference of create.asyncThunk type parameters
  • fixes requirements for meta fields returned from queryFns
  • marks promises that will never reject as safe, in preparation for Enhancement: [no-floating-promises] add an 'allowForKnownSafePromises' option typescript-eslint/typescript-eslint#7008

@EskiMojo14
Copy link
Collaborator Author

the last four don't need documentation, they're essentially bug fixes.

as you've noted, skipPollingIfUnfocused and createSelector for RTKQ are now documented, so it should just be making sure .withTypes is documented :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants