fix(useFavicon): writable return type #2036
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
antfu
reviewed
Aug 3, 2022
packages/core/useFavicon/index.ts
Outdated
Comment on lines
13
to
14
| export type UseFaviconValue = string | null | undefined | ||
| export type UseFaviconGetter = () => UseFaviconValue |
antfu
reviewed
Aug 3, 2022
packages/core/useFavicon/index.ts
Outdated
| /** | ||
| * Reactive favicon. | ||
| * | ||
| * @see https://vueuse.org/useFavicon | ||
| * @param newIcon | ||
| * @param options | ||
| */ | ||
| export function useFavicon(newIcon: MaybeRef<UseFaviconValue>, options?: UseFaviconOptions): Ref<UseFaviconValue> | ||
| export function useFavicon(newIcon: ComputedRef<UseFaviconValue> | UseFaviconGetter, options?: UseFaviconOptions): ComputedRef<UseFaviconValue> |
There was a problem hiding this comment.
Suggested change
| export function useFavicon(newIcon: ComputedRef<UseFaviconValue> | UseFaviconGetter, options?: UseFaviconOptions): ComputedRef<UseFaviconValue> | |
| export function useFavicon(newIcon: MaybeComputedRef<UseFaviconValue>, options?: UseFaviconOptions): ComputedRef<UseFaviconValue> |
There was a problem hiding this comment.
In this case the return type for Ref will be ComputedRef.
I mean for useFavicon(ref('str')): ComputedRef
chaii3
force-pushed
the
useFavicon_return_type
branch
from
8043e2f
to
f5a825e
Compare
antfu
approved these changes
Aug 4, 2022
|
@antfu Sorry to get back to this again, but the function without parameters still returns a ComputedRef. Therefore, it still does not match the documentation.
|
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.
closes #2031
Description
Additional context
What is the purpose of this pull request?
Before submitting the PR, please make sure you do the following
fixes #123).