![\"usefy](\"https://raw.githubusercontent.com/mirunamu00/usefy/master/assets/logo.png\"){kind=logo}
\n\n \n
\n A powerful React hook for one-time initialization with async support, retry, timeout, and conditional execution\n
\n\n\n \n ![\"npm](\"https://img.shields.io/npm/v/@usefy/use-init.svg?style=flat-square&color=007acc\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/dm/@usefy/use-init.svg?style=flat-square&color=007acc\")
\n \n \n ![\"bundle](\"https://img.shields.io/bundlephobia/minzip/@usefy/use-init?style=flat-square&color=007acc\")
![\"license\"](\"https://img.shields.io/npm/l/@usefy/use-init.svg?style=flat-square&color=007acc\")
\n \n
\n Installation ā¢\n Quick Start ā¢\n API Reference ā¢\n Examples ā¢\n License\n
\n\n\n \n š View Storybook Demo\n \n
\n\n---\n\n## Overview\n\n`@usefy/use-init` is a React hook for executing initialization logic exactly once when a component mounts. It supports synchronous and asynchronous callbacks, automatic retry on failure, timeout handling, conditional execution, and cleanup functions. Perfect for initializing services, loading configuration, setting up subscriptions, and any one-time setup tasks.\n\n**Part of the [@usefy](https://www.npmjs.com/org/usefy) ecosystem** ā a collection of production-ready React hooks designed for modern applications.\n\n### Why use-init?\n\n- **Zero Dependencies** ā Pure React implementation with no external dependencies\n- **TypeScript First** ā Full type safety with exported interfaces\n- **One-Time Execution** ā Guarantees initialization runs only once per mount\n- **Async Support** ā Handles both synchronous and asynchronous initialization callbacks\n- **Cleanup Functions** ā Optional cleanup function support for resource management\n- **Retry Logic** ā Automatic retry with configurable attempts and delays\n- **Timeout Handling** ā Built-in timeout support with custom error handling\n- **Conditional Execution** ā Run initialization only when conditions are met\n- **State Tracking** ā Track initialization status, loading state, and errors\n- **Manual Reinitialize** ā Trigger re-initialization programmatically\n- **SSR Compatible** ā Works seamlessly with Next.js, Remix, and other SSR frameworks\n- **Well Tested** ā Comprehensive test coverage with Vitest\n\n---\n\n## Installation\n\n```bash\n# npm\nnpm install @usefy/use-init\n\n# yarn\nyarn add @usefy/use-init\n\n# pnpm\npnpm add @usefy/use-init\n```\n\n### Peer Dependencies\n\nThis package requires React 18 or 19:\n\n```json\n{\n \"peerDependencies\": {\n \"react\": \"^18.0.0 || ^19.0.0\"\n }\n}\n```\n\n---\n\n## Quick Start\n\n```tsx\nimport { useInit } from \"@usefy/use-init\";\n\nfunction MyComponent() {\n const { isInitialized, isInitializing, error } = useInit(async () => {\n await loadConfiguration();\n console.log(\"Component initialized!\");\n });\n\n if (isInitializing) returnFailed to connect: {error.message}
\n \nError: {error.message}
\n \nwhen)\n Built with care by the usefy team\n
\n","readmeFilename":"README.md"}