@toolz/use-constructor

1.0.1 • Public • Published

use-constructor

use-constructor is a custom Hook that provides constructor-like functionality to functional React components. Functional components are not classes. As such, they have no true equivalent to a constructor.

useEffect() is typically touted as the replacement for all lifecycle methods. But useEffect() always fires after the component has rendered. Any code block that is called directly within the body of a functional component will fire every time that component is called (which can happen many successive times during React's reconciliation process).

By leveraging a simple ref variable, we can fire a code block before the component renders and ensure that it's only ever fired once for the life of the component.

Usage

After installation, import the package as follows:

import { useConstructor } from '@toolz/use-constructor';

Methods

useConstructor()

const API = {
   arguments: {
      callBack: {
         required,
         format: Function,
      },
   },
   returns: void
}

Examples:

const SomeComponent = () => {
   useConstructor(() => {
      /*
         This code runs once, and only once, for the lifecycle of 
         this component.  This code also runs before the render 
         cycle.
      */
   });
   
   return <>Some JSX</>
}

Since this is a type of "faux-constructor" functionality, there is no magic that ensures the logic inside useConstructor() will run before anything else happens in your functional component. So it's perfectly possible to process other logic before you call useConstructor(). If you want it to act as a "true" constructor, you would need to ensure that it's called at the very top of the functional component.

Package Sidebar

Install

npm i @toolz/use-constructor

Weekly Downloads

27

Version

1.0.1

License

MIT

Unpacked Size

5.1 kB

Total Files

4

Last publish

Collaborators

  • bytebodger