Kong/swrv

Omitting fetcher function argument is ambiguous?

Open

#148 opened on Mar 21, 2021

View on GitHubContributor guide
 (6 comments) (0 reactions) (0 assignees)TypeScript (77 forks)github user discovery
help wanted

Repository metrics

Stars
 (2,280 stars)
PR merge metrics
 (PR metrics pending)

Description

The README states:

Note that fetcher can be any asynchronous function, so you can use your favorite data-fetching library to handle that part. If ommitted, swrv uses the Fetch api.

But later also:

To only retrieve a swrv cache response without revalidating, you can omit the fetcher function from the useSWRV call.

So, which one is it? :) Or am I misunderstanding what omitting means in the first case?

Contributor guide

Research direction
Examine the README sections that mention omitting the fetcher and clarify the two different contexts: one for default fetcher usage and one for cache only retrieval. Propose rewording to avoid ambiguity.
Tech stack
typescriptvue
Domain
frontendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85