npmpackage.info

react-scoped-model-swr

Contextual state management for React, ReasonReact and Preact

3.0.1

MIT

TypeScript

64.30 kB

5,130 2.5

Installations

npm install react-scoped-model-swr

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

>=10

Node Version

16.8.0

NPM Version

lerna/4.0.0/node@v16.8.0+x64 (win32)

Score

66.8

Supply Chain

93.6

Quality

75.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

3

Total

21

Closed

2

Merged

16

Issues

Open

0

Total

6

Closed

6

Releases

v2.0.0

Published on 04 Apr 2021

graph-state@0.5.0

Published on 03 Nov 2020

swr-graph-state@0.5.0

Published on 03 Nov 2020

swr-graph-state@0.4.0

Published on 23 Oct 2020

graph-state@0.2.0

Published on 13 Oct 2020

preact-scoped-model@0.3.0

Published on 09 Oct 2020

View all 24 releases

Contributors

Unable to fetch Contributors

View all 1 contributors

Languages

TypeScript

Reason

JavaScript

C++

TypeScript (78.08%)

Reason (11.34%)

JavaScript (10.53%)

C++ (0.05%)

Developer

LXSMNSYC

Download Statistics

Total Downloads

5,130

Last Day

Last Week

Last Month

Last Year

541

GitHub Statistics

23 Stars

684 Commits

3 Watching

6 Branches

1 Contributors

Maintainers

Package Meta Information

Latest Version

3.0.1

Package Id

react-scoped-model-swr@3.0.1

Unpacked Size

64.30 kB

Size

7.81 kB

File Count

NPM Version

lerna/4.0.0/node@v16.8.0+x64 (win32)

Node Version

16.8.0

Total Downloads

Cumulative downloads

Total Downloads

5,130

Last day

Compared to previous day

Last week

5,000%

Compared to previous week

Last month

330.8%

Compared to previous month

Last year

-21.5%

541

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

react react-scoped-model swr

Dev Dependencies

@types/node @types/react eslint eslint-config-lxsmnsyc pridepack react react-dom react-scoped-model swr tslib typescript

Versions

react-scoped-model-swr

react-scoped-model + Vercel's SWR

Usage

Basic Usage

The package exports two model factories: createSWRModel and createSWRInfiniteModel.

1import { createSWRModel } from 'react-scoped-model';

The simplest form of an SWR Model can be created using just a key value.

1const TopItems = createSWRModel('/api/items/top');

which can be mounted like a scoped model instance:

1<TopItems.Provider>
2  <TopItemsList />
3</TopItems.Provider>

And can be used with hooks:

1import { useSelector } from 'react-scoped-model';
2
3// ...
4const data = useSelector(TopItems, (state) => state.data);

All SWR and SWR Infinite models are also subject to the <SWRConfig> setup.

The second parameter for createSWRModel is reserved for custom fetching, but it is required to be returned by a higher-order function:

1const TopItems = createSWRModel('/api/items/top', () => getTopItems);

The third parameter is an optional parameter and is for the SWR Config.

1const TopItems = createSWRModel('/api/items/top', () => getTopItems, {
2  initialData: [],
3});

The fourth parameter is an optional parameter reserved for the scoped model options e.g. displayName.

Props and Dependent Fetching

SWR and SWR Infinite models can also receive props, and can be used to produce dynamic key, fetcher and config, which can cause dependent or conditional fetching;

1const UserDetails = createSWRModel(
2  ({ userId }) => `/api/user/${userId}`,
3  ({ userId }) => () => getUser(userId),
4);
5
6// ...
7<UserDetails.Provider userId={userId}>
8  <UserProfile />
9</UserDetails.Provider>

You may also use hooks inside these functions as they behave as hooks:

1const RecentActivity = createSWRModel(
2  () => {
3    // Get the current sign-in token
4    const token = useAuthToken();
5
6    // Only fetch if a token exists,
7    // signifying the signed-in user's presence
8    if (token) {
9      return ['/api/recent-activity', token];
10    }
11    return null,
12  },
13  () => getRecentActivity,
14);

License

MIT © lxsmnsyc

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Maintained

Determines if the project is "actively maintained".

0

SAST

Determines if the project uses static code analysis.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Security-Policy

Determines if the project has published a security policy.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2.5

/10

Last Scanned on 2024-12-23

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

Other packages similar to react-scoped-model-swr

@lxsmnsyc/react-scoped-model-swr

0.2.2

SWR + react-scoped-model