useOnce

Hook that runs an effect only once. Please do not use it in production code!

humorlowtest coverage

Warning

This hook will run effect only once even in strict mode. Please do not use it in production code!

This effect ran once

With useOnce the effect fires a single time, even in Strict Mode where a regular effect would run twice. Open the console to see the log.

import { useOnce } from '@siberiacancode/reactuse';

const Demo = () => {
  useOnce(() => {
    console.log('effect ran once');
  });

  return (
    <section className='flex w-full max-w-md flex-col items-center gap-3 p-6'>
      <div className='flex flex-col items-center gap-1 text-center'>
        <h2 className='text-foreground text-sm font-semibold'>This effect ran once</h2>
        <p className='text-muted-foreground text-xs'>
          With <code>useOnce</code> the effect fires a single time, even in Strict Mode where a
          regular effect would run twice. Open the console to see the log.
        </p>
      </div>
    </section>
  );
};

export default Demo;

Installation

pnpm add @siberiacancode/reactuse

Usage

useOnce(() => console.log('effect once'));

Type Declarations

import type { EffectCallback } from 'react';

API

Parameters

Name	Type	Default	Note
effect	`EffectCallback`	-	The effect to run

Contributors

ddebabin

Last updated on

useLess useInterval