npmpackage.info

Gathering detailed insights and metrics for make-cancellable-promise

make-cancellable-promise

Make any Promise cancellable.

1.3.2

MIT

TypeScript

105,077,328 5.1

Installations

npm install make-cancellable-promise

Pull Requests

Open

0

Total

88

Closed

61

Merged

27

Issues

Open

0

Total

0

Closed

0

Releases

v1.3.2

Published on 18 Oct 2023

v1.3.1

Published on 29 May 2023

v1.3.0

Published on 29 May 2023

v1.2.1

Published on 02 Feb 2023

v1.2.0

Published on 10 Jan 2023

v1.1.0

Published on 13 Sept 2021

View all 7 releases

Developer

wojtekmaj

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

Yes

Node Version

20.8.0

NPM Version

10.1.0 Statistics

28 Stars

214 Commits

2 Forks

3 Watching

3 Branches

1 Contributors

Updated on 20 Nov 2024

Languages

TypeScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

105,077,328

Last day

-6.3%

185,846

Compared to previous day

Last week

0.6%

1,009,223

Compared to previous week

Last month

7.3%

4,355,454

Compared to previous month

Last year

48%

42,639,407

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

eslint eslint-config-wojtekmaj husky lint-staged prettier rimraf typescript vitest

Versions

downloads

Make-Cancellable-Promise

Make any Promise cancellable.

tl;dr

Install by executing npm install make-cancellable-promise or yarn add make-cancellable-promise.
Import by adding import makeCancellablePromise from 'make-cancellable-promise.

Do stuff with it!

1const { promise, cancel } = makeCancellablePromise(myPromise);

User guide

makeCancellablePromise(myPromise)

A function that returns an object with two properties:

promise and cancel. promise is a wrapped around your promise. cancel is a function which stops .then() and .catch() from working on promise, even if promise passed to makeCancellablePromise resolves or rejects.

Usage

1const { promise, cancel } = makeCancellablePromise(myPromise);

Typically, you'd want to use makeCancellablePromise in React components. If you call setState on an unmounted component, React will throw an error.

Here's how you can use makeCancellablePromise with React:

1function MyComponent() {
2  const [status, setStatus] = useState('initial');
3
4  useEffect(() => {
5    const { promise, cancel } = makeCancellable(fetchData());
6
7    promise.then(() => setStatus('success')).catch(() => setStatus('error'));
8
9    return () => {
10      cancel();
11    };
12  }, []);
13
14  const text = (() => {
15    switch (status) {
16      case 'pending':
17        return 'Fetching…';
18      case 'success':
19        return 'Success';
20      case 'error':
21        return 'Error!';
22      default:
23        return 'Click to fetch';
24    }
25  })();
26
27  return <p>{text}</p>;
28}

License

The MIT License.

Author

Wojciech Maj

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

License

Determines if the project has defined a license.

10

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

9

Maintained

Determines if the project is "actively maintained".

0

Code-Review

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

0

Token-Permissions

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

0

Pinned-Dependencies

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

Reason

dependency not pinned by hash detected -- score normalized to 0

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:79: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:92: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/ci.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/close-stale-issues.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/close-stale-issues.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/publish.yml/main?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/make-cancellable-promise/publish.yml/main?enable=pin
Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
Info: 0 out of 2 third-party GitHubAction dependencies pinned

0

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

5.1

/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