feat(signal): remove passed signal from defautlMapOptionsToKey #83
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
|
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 aedde24:
|
code-forger
reviewed
Aug 7, 2023
| @@ -16,6 +16,7 @@ | |||
|
|
|||
| export const defaultMapOptionsToKey = (options) => { | |||
| const { | |||
| signal, | |||
There was a problem hiding this comment.
Can you make a unit tests that calls this function with this name and shows that it is removed.
One that would fail if this change was reverted
JAdshead
reviewed
Aug 21, 2023
README.md
Outdated
| @@ -748,7 +773,7 @@ A React Hook used for dispatching asynchronous API requests. | |||
| **Shape** | |||
|
|
|||
| ``` | |||
| const { isLoading, data, error, run } = useFetchye(key, { defer: Boolean, mapOptionsToKey: options => options, ...fetchOptions }, fetcher); | |||
| const { isLoading, data, error, run } = useFetchye(key, { signal: {}, defer: Boolean, mapOptionsToKey: options => options, ...fetchOptions }, fetcher); | |||
There was a problem hiding this comment.
signal is a fetch api that would be included as part of fetchOptions and is not part of the useFetchye api so should be removed from here.
Suggested change
| const { isLoading, data, error, run } = useFetchye(key, { signal: {}, defer: Boolean, mapOptionsToKey: options => options, ...fetchOptions }, fetcher); | |
| const { isLoading, data, error, run } = useFetchye(key, { defer: Boolean, mapOptionsToKey: options => options, ...fetchOptions }, fetcher); |
JAdshead
reviewed
Aug 21, 2023
README.md
Outdated
| @@ -765,6 +790,7 @@ const { isLoading, data, error, run } = useFetchye(key, { defer: Boolean, mapOpt | |||
| |--------------------|-------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------| | |||
| | `mapOptionsToKey` | `(options: Options) => transformedOptions` | `false` | A function that maps options to the key that will become part of the cache key | | |||
| | `mapKeyToCacheKey` | `(key: String, options: Options) => cacheKey: String` | `false` | A function that maps the key for use as the cacheKey allowing direct control of the cacheKey | | |||
| | `signal` | `Object` | `false` | Prevents execution of `useFetchye` when desired cancelling DOM request (See [Abort Controller](https://developer.mozilla.org/en-US/docs/Web/API/AbortController)). | | |||
There was a problem hiding this comment.
This is not a useFetchye api so should be removed.
Suggested change
| | `signal` | `Object` | `false` | Prevents execution of `useFetchye` when desired cancelling DOM request (See [Abort Controller](https://developer.mozilla.org/en-US/docs/Web/API/AbortController)). | |
JAdshead
reviewed
Aug 21, 2023
README.md
Outdated
| @@ -337,6 +337,31 @@ const NewBookForm = () => { | |||
| }; | |||
| ``` | |||
|
|
|||
| ### Abort Signal | |||
There was a problem hiding this comment.
Im not sure that this should be documented in this mannor, else the readme should document all of the fetch apis.
Maybe this should be framed as an example of aborting an inflight request on unmount to demonstraight that useFetchye is just a wrapper around fetch.
JAdshead
requested changes
Aug 21, 2023
README.md
Outdated
| ### Abort Signal | ||
|
|
||
| When you neeed to abort the execution of a `useFetchye` call, you may | ||
| pass a signal as an option in such way. |
There was a problem hiding this comment.
Suggested change
| pass a signal as an option in such way. | |
| pass a signal as an option, as demonstrated below. |
dogpatch626
requested review from
Matthew-Mallimo,
JAdshead and
10xLaCroixDrinker
8 tasks
10xLaCroixDrinker
approved these changes
Aug 24, 2023
JAdshead
approved these changes
Aug 24, 2023
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.
Description
add support for abortController by allowing a signal to be passed as an option
Motivation and Context
How Has This Been Tested?
tested locally passing signal as options
Types of Changes
Checklist:
What is the Impact to Developers Using Fetchye?