feature: allow using skipSymbol as arg in hooks #1056
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
instead of the `skip` option
phryneas
commented
May 15, 2021
Comment on lines
+21
to
+43
| /** | ||
| * Can be passed into `useQuery`, `useQueryState` or `useQuerySubscription` | ||
| * instead of the query argument to get the same effect as if setting | ||
| * `skip: true` in the query options. | ||
| * | ||
| * Useful for scenarios where a query should be skipped when `arg` is `undefined` | ||
| * and TypeScript complains about it because `arg` is not allowed to be passed | ||
| * in as `undefined`, such as | ||
| * | ||
| * ```ts | ||
| * // codeblock-meta title="will error if the query argument is not allowed to be undefined" no-transpile | ||
| * useSomeQuery(arg, { skip: !!arg }) | ||
| * ``` | ||
| * | ||
| * ```ts | ||
| * // codeblock-meta title="using skipSymbol instead" no-transpile | ||
| * useSomeQuery(arg ?? skipSymbol) | ||
| * ``` | ||
| * | ||
| * If passed directly into a query or mutation selector, that selector will always | ||
| * return an uninitialized state. | ||
| */ | ||
| export const skipSymbol = Symbol('skip selector') |
There was a problem hiding this comment.
This should describe what it does ;)
This was referenced May 15, 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 ecaf556:
|
|
Size Change: +220 B (0%) Total Size: 535 kB
ℹ️ View Unchanged
|
|
Deploy preview for redux-starter-kit-docs ready! Built with commit ecaf556 https://deploy-preview-1056--redux-starter-kit-docs.netlify.app |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This still needs tests.
This will resolve
arg: ... | undefinedif{skip: true}in useQuery rtk-incubator/rtk-query#220Thanks @omerman for the suggestion.
Naming is as always up for debate. @omerman suggested
skipTokenwhich should also fit the bill fine.@markerikson opinions?