Installations

npm install one-time

Pull Requests

Open

0

Total

14

Closed

5

Merged

9

Issues

Open

0

Total

3

Closed

3

Releases

Unable to fetch releases

Developer

3rd-Eden

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

No

Node Version

8.11.4

NPM Version

6.4.0 Statistics

9 Stars

44 Commits

3 Forks

5 Watching

1 Branches

3 Contributors

Updated on 10 Jul 2023

Languages

JavaScript (100%)

Total Downloads

Cumulative downloads

Total Downloads

1,519,733,242

Last day

-9.9%

1,655,148

Compared to previous day

Last week

0.4%

9,847,288

Compared to previous week

Last month

6.5%

41,576,137

Compared to previous month

Last year

4.4%

436,006,638

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

1

fn.name

Dev Dependencies

3

assume mocha nyc

Versions

one-time

Call the supplied function exactly one time. This prevents double callback execution. This module can be used on both Node.js, React-Native, or browsers using Browserify. No magical ES5/6 methods used unlike the once module does (except for the async version).

Installation

This module is published to the public npm registry and can be installed by running:

1npm install --save one-time

Usage (normal)

Simply supply the function with the function that should only be called one time:

1var one = require('one-time');
2
3function load(file, fn) {
4  fn = one(fn);
5
6  eventemitter.once('load', fn);
7  eventemitter.once('error', fn);
8
9  // do stuff
10  eventemitter.emit('error', new Error('Failed to load, but still finished'));
11  eventemitter.emit('load');
12}
13
14function example(fn) {
15  fn = one(fn);
16
17  fn();
18  fn('also receives all arguments');
19  fn('it returns the same value') === 'bar';
20  fn('never');
21  fn('gonna');
22  fn('give');
23  fn('you');
24  fn('up');
25}
26
27example(function () {
28  return 'bar'
29});

Usage (async)

The same pattern is available for async functions as well, for that you should import that one-time/async version instead. This one is optimized for async and await support. It following exactly the same as the normal version but assumes it's an async function () {} that it's wrapping instead of a regular function, and it will return an async function() {} instead of a regular function.

1import one from 'one-time/async';
2
3const fn = one(async function () {
4  return await example();
5});
6
7await fn();
8await fn();
9await fn();

Why not `once`?

The main reason is that once cannot be used in a browser environment unless it's ES5 compatible. For a module as simple as this I find that unacceptable. In addition to that it super heavy on the dependency side. So it's totally not suitable to be used in client side applications.

In addition to that we make sure that your code stays easy to debug as returned functions are named in the same way as your supplied functions. Making heap inspection and stack traces easier to understand.

License

MIT

No vulnerabilities found.

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

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

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.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

1.7

/10

Last Scanned on 2024-11-25

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

one-time

Installations

Pull Requests

0

14

5

9

Issues

0

3

3

Releases

Unable to fetch releases

Developer

3rd-Eden

Developer Guide

CommonJS

No

8.11.4

6.4.0

Statistics

Languages

Total Downloads

1,519,733,242

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

one-time

Installation

Usage (normal)

Usage (async)

Why not once?

License

10

10

0

0

0

0

0

0

0

0

1.7

/10

Why not `once`?