Gathering detailed insights and metrics for swr
Gathering detailed insights and metrics for swr
Installations
npm install swrReleases
115
Developer
Developer Guide
BETA
Module System
CommonJS, ESM
Min. Node Version
Typescript Support
Yes
Node Version
18.19.0
NPM Version
10.2.3
Statistics
30,622 Stars
881 Commits
1,220 Forks
217 Watching
16 Branches
244 Contributors
Updated on 28 Nov 2024
Bundle Size
10.17 kB
Minified
4.46 kB
Minified + Gzipped
Languages
TypeScript (99.22%)
JavaScript (0.77%)
Shell (0.02%)
Total Downloads
Cumulative downloads
Total Downloads
225,135,223
Last day
-5.4%
449,286
Compared to previous day
Last week
11.8%
2,712,624
Compared to previous week
Last month
7.7%
10,598,785
Compared to previous month
Last year
62.6%
103,038,193
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
2
Peer Dependencies
1
Dev Dependencies
33
swrjestnexthuskyreacteslintrimrafsemverbuncheeprettier@swc/core@swc/jestreact-domtypescript@types/jest@types/nodelint-staged@types/react@playwright/testeslint-plugin-reactreact-error-boundary@arethetypeswrong/cli@testing-library/react@type-challenges/utilseslint-config-prettiereslint-plugin-jest-domjest-environment-jsdom@testing-library/jest-dom@typescript-eslint/parsereslint-plugin-react-hookseslint-plugin-testing-library@types/use-sync-external-store@typescript-eslint/eslint-plugin
Versions
Introduction
SWR is a React Hooks library for data fetching.
The name “SWR” is derived from stale-while-revalidate, a cache invalidation strategy popularized by HTTP RFC 5861.
SWR first returns the data from cache (stale), then sends the request (revalidate), and finally comes with the up-to-date data again.
With just one hook, you can significantly simplify the data fetching logic in your project. And it also covered in all aspects of speed, correctness, and stability to help you build better experiences:
- Fast, lightweight and reusable data fetching
- Transport and protocol agnostic
- Built-in cache and request deduplication
- Real-time experience
- Revalidation on focus
- Revalidation on network recovery
- Polling
- Pagination and scroll position recovery
- SSR and SSG
- Local mutation (Optimistic UI)
- Built-in smart error retry
- TypeScript
- React Suspense
- React Native
...and a lot more.
With SWR, components will get a stream of data updates constantly and automatically. Thus, the UI will be always fast and reactive.
View full documentation and examples on swr.vercel.app.
Quick Start
1import useSWR from 'swr' 2 3function Profile() { 4 const { data, error, isLoading } = useSWR('/api/user', fetcher) 5 6 if (error) return <div>failed to load</div> 7 if (isLoading) return <div>loading...</div> 8 return <div>hello {data.name}!</div> 9}
In this example, the React Hook useSWR accepts a key and a fetcher function.
The key is a unique identifier of the request, normally the URL of the API. And the fetcher accepts
key as its parameter and returns the data asynchronously.
useSWR also returns 3 values: data, isLoading and error. When the request (fetcher) is not yet finished,
data will be undefined and isLoading will be true. When we get a response, it sets data and error based on the result
of fetcher, isLoading to false and rerenders the component.
Note that fetcher can be any asynchronous function, you can use your favourite data-fetching
library to handle that part.
View full documentation and examples on swr.vercel.app.
Authors
This library is created by the team behind Next.js, with contributions from our community:
- Shu Ding (@shuding_) - Vercel
- Guillermo Rauch (@rauchg) - Vercel
- Joe Haddad (@timer150) - Vercel
- Paco Coursey (@pacocoursey) - Vercel
Thanks to Ryan Chen for providing the awesome swr npm package name!
License
The MIT License.
No vulnerabilities found.
Reason
security policy file detected
Details
- Info: security policy file detected: .github/SECURITY.md:1
- Info: Found linked content: .github/SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: .github/SECURITY.md:1
- Info: Found text in security policy: .github/SECURITY.md:1
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 20/30 approved changesets -- score normalized to 6
Reason
0 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 2
Reason
8 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-hpx4-r86g-5jrg
- Warn: Project is vulnerable to: GHSA-prr3-c3m5-p7q2
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/test-canary.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-legacy-react.yml:1
- Warn: no topLevel permission defined: .github/workflows/test-release.yml:1
- Warn: no topLevel permission defined: .github/workflows/trigger-release.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-canary.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/swr/test-canary.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-legacy-react.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/swr/test-legacy-react.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/swr/test-release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/swr/test-release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/swr/test-release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test-release.yml:61: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/swr/test-release.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/trigger-release.yml:34: update your workflow using https://app.stepsecurity.io/secureworkflow/vercel/swr/trigger-release.yml/main?enable=pin
- Info: 0 out of 7 GitHub-owned GitHubAction dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 24 are checked with a SAST tool
Score
4.5
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More