npmpackage.info

Gathering detailed insights and metrics for @awgv/use-timer-hook

@awgv/use-timer-hook - 1.0.12 | npmpackage.info

@awgv/use-timer-hook

A pausable timer for React with millisecond precision; useful for notifications or buttons with delayed actions.

1.0.12

MIT

JavaScript

8.17 kB

3.4

Installations

npm install @awgv/use-timer-hook

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

20.13.1

NPM Version

10.8.1 Pull Requests

Open

0

Total

8

Closed

4

Merged

4

Issues

Open

0

Total

1

Closed

1

Releases

v1.0.12

Updated on Jun 04, 2024

v1.0.11

Updated on Jun 04, 2024

v1.0.10

Updated on Apr 24, 2023

v1.0.9

Updated on Jun 10, 2022

v1.0.8

Updated on Jun 04, 2022

v1.0.7

Updated on Jun 03, 2022

View All 13 releases

Languages

JavaScript

JavaScript (100%)

Developer

awgv

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2 Stars

27 Commits

2 Watchers

1 Branches

1 Contributors

Updated on Jan 09, 2025

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

1.0.12

Package Id

@awgv/use-timer-hook@1.0.12

Unpacked Size

8.17 kB

Size

3.28 kB

File Count

NPM Version

10.8.1

Node Version

20.13.1

Published on

Jun 04, 2024

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Peer Dependencies

react react-dom

Dev Dependencies

@types/react semantic-release

@awgv/use-timer-hook

Total amount of NPM downloads

The hook was created as an abstraction for notifications and is essentially a pausable setTimeout(). Neither setInterval() nor Date() objects are used, so if you need conventional clock functionality, you might want to check out packages that provide date/time information like amrlabib/react-timer-hook.

Usage

Package name:

@awgv/use-timer-hook

The hook is well-documented internally, so you can rely on your editor for intelligent code completion.

1import { useTimer } from '@awgv/use-timer-hook'
2
3export function YourComponent() {
4  const {
5    /**
6     * ⏲ Returns true if the timer is running.
7     */
8    timerIsRunning,
9    /**
10     * ⏳ Stores the running timer’s remaining time and updates
11     * when the timer is paused or restarted.
12     */
13    remainingTime,
14    /**
15     * 🔁 Starts or restarts the timer.
16     */
17    restartTimer,
18    /**
19     * ⏯ Resumes a paused timer.
20     */
21    resumeTimer,
22    /**
23     * ⏸ Pauses a running timer.
24     */
25    pauseTimer,
26    /**
27     * ⏹ Completely stops the timer.
28     */
29    stopTimer,
30  } = useTimer({
31    /**
32     * The duration, in milliseconds, the timer should wait before
33     * `callbackToExecuteOnExpiry()` is executed.
34     */
35    totalDurationInMilliseconds: 1000,
36    /**
37     * A function to be executed after the timer expires.
38     */
39    callbackToExecuteOnExpiry: () => {},
40  })
41}

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.

10

Packaging

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

3

Pinned-Dependencies

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

3

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

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

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

Branch-Protection

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

0

SAST

Determines if the project uses static code analysis.

Score

3.4

/10

Last Scanned on 2025-07-14

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