Sha256: 3e6fa47c6adf6cc0bbb8965e4d3bff85a78317c9e4f46eef627e1f77b8bd3c82

Contents?: true

Size: 892 Bytes

Versions: 49

Compression:

Stored size: 892 Bytes

Contents

# onetime [![Build Status](https://travis-ci.org/sindresorhus/onetime.svg?branch=master)](https://travis-ci.org/sindresorhus/onetime)

> Only call a function once

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

*Unlike the module [once](https://github.com/isaacs/once), this one isn't naughty extending `Function.prototype`.*


## Install

```
$ npm install --save onetime
```


## Usage

```js
let i = 0;

const foo = onetime(() => i++);

foo(); //=> 0
foo(); //=> 0
foo(); //=> 0
```


## API

### onetime(function, [shouldThrow])

#### function

Type: `function`

Function that should only be called once.

#### shouldThrow

Type: `boolean`  
Default: `false`

![](screenshot-shouldthrow.png)

Set to `true` if you want it to fail with a nice and descriptive error when called more than once.


## License

MIT © [Sindre Sorhus](http://sindresorhus.com)

Version data entries

49 entries across 49 versions & 5 rubygems

Version Path
govuk_publishing_components-18.0.0 node_modules/onetime/readme.md
govuk_publishing_components-17.21.0 node_modules/onetime/readme.md
govuk_publishing_components-17.20.0 node_modules/onetime/readme.md
govuk_publishing_components-17.19.1 node_modules/onetime/readme.md
govuk_publishing_components-17.19.0 node_modules/onetime/readme.md
govuk_publishing_components-17.18.0 node_modules/onetime/readme.md
govuk_publishing_components-17.17.0 node_modules/onetime/readme.md
govuk_publishing_components-17.16.0 node_modules/onetime/readme.md
govuk_publishing_components-17.15.0 node_modules/onetime/readme.md
govuk_publishing_components-17.14.0 node_modules/onetime/readme.md
govuk_publishing_components-17.13.0 node_modules/onetime/readme.md
govuk_publishing_components-17.12.2 node_modules/onetime/readme.md
govuk_publishing_components-17.12.1 node_modules/onetime/readme.md
govuk_publishing_components-17.12.0 node_modules/onetime/readme.md
govuk_publishing_components-17.11.0 node_modules/onetime/readme.md
govuk_publishing_components-17.10.0 node_modules/onetime/readme.md
govuk_publishing_components-17.9.0 node_modules/onetime/readme.md
govuk_publishing_components-17.8.0 node_modules/onetime/readme.md
govuk_publishing_components-17.7.0 node_modules/onetime/readme.md
govuk_publishing_components-17.6.1 node_modules/onetime/readme.md