Skip to content

Repository files navigation

onetime

Ensure a function is only called once

When called multiple times it will return the return value from the first call.

Unlike the module once, this one isn't naughty and extending Function.prototype.

Install

npm install onetime

Usage

importonetimefrom'onetime';letindex=0;constfoo=onetime(()=>++index);foo();//=> 1foo();//=> 1foo();//=> 1onetime.callCount(foo);//=> 3
importonetimefrom'onetime';constfoo=onetime(()=>{},{throw: true});foo();foo();//=> Error: Function `foo` can only be called once

API

onetime(fn, options?)

Returns a function that only calls fn once.

fn

Type: Function

The function that should only be called once.

options

Type: object

throw

Type: boolean
Default: false

Throw an error when called more than once.

onetime.callCount(fn)

Returns a number representing how many times fn has been called.

Note: It throws an error if you pass in a function that is not wrapped by onetime.

importonetimefrom'onetime';constfoo=onetime(()=>{});foo();foo();foo();console.log(onetime.callCount(foo));//=> 3

fn

Type: Function

The function to get call count from.

About

Ensure a function is only called once

Resources

Code of conduct

Contributing

Security policy

Stars

167 stars

Watchers

6 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages