Logo for jsDocs.io

onetime

  • Version 7.0.0
  • Published
  • 5.45 kB
  • 1 dependency
  • MIT license

Install

npm i onetime
yarn add onetime
pnpm add onetime

Overview

Ensure a function is only called once

Index

Variables

Type Aliases

Variables

variable onetime

const onetime: {
    <ArgumentsType extends unknown[], ReturnType>(
        fn: (...arguments_: ArgumentsType) => ReturnType,
        options?: Options
    ): (...arguments_: ArgumentsType) => ReturnType;
    callCount(fn: (...arguments_: any[]) => unknown): number;
};

    Type Aliases

    type Options

    type Options = {
        /**
    	Throw an error when called more than once.
    

    	@default false
    	*/
        readonly throw?: boolean;
    };

      Package Files (1)

      Dependencies (1)

      Dev Dependencies (3)

      Peer Dependencies (0)

      No peer dependencies.

      Badge

      To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

      You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/onetime.

      • Markdown
        [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/onetime)
      • HTML
        <a href="https://www.jsdocs.io/package/onetime"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>