{"bugs":{"url":"https://github.com/testing-library/react-hooks-testing-library/issues"},"dist":{"shasum":"f227f95b67f233b3ec34bfcf76530ebc558516f2","tarball":"https://registry.npmjs.org/@testing-library/react-hooks/-/react-hooks-5.0.0-beta.9.tgz","fileCount":112,"integrity":"sha512-3ycYgXas6Ghig5uFaE4aNwJYuWW4AKE3LsAbtIjzSOypnX4n1Kg/CItpdyBbQ9yxUD8czqO0/NH7Su73OYF6uw==","signatures":[{"sig":"MEQCIAIOuuB/Aa41XpyD4xiqGZToD9/YstjSxpjU0R72olL/AiA6n/iiVRCYS9oBTgzhqqXo0GVhVtC8rvGOrYqjGDugIQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":150675,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf/W38CRA9TVsSAnZWagAAF8IP/1XG5FslQuJF8VJ7s7kP\nSfUIuTu1Oa/rv5mVVr8ARK7yWEjqRGyBwW3uk5MXRPzNJqxwui9+8zcECryr\nauUJ5VP/4fgwULElpV1kstvP+ymheIY3MtYUAZl6KLxnxQquKMQXqy7VQlXs\n4+e5SeaPYN1W8HrCVuS7SFxMNNVyzZE8SWGjBSF6yqZS2KcedUePZGdyF/xa\nNIHJEZBkg73zDXtLny2lcscXVXBA0D7wEonbS4xvYXXqMzHATVdlIILCcn7m\nBDhg5fGgrw2cCY8IUpQJzUbflWq8r8aSoMPR1WKfs0exp6Sxr7CpyHDrO01u\nwIYdrgiC2DAQDs7x5mdyYbN9ovFEY+oskzwh04ktE3VZLPKIEVnKrYNN4F2c\nspHHkehjId/pEpsZ/CBTQym+bJul/HT5NjK5YCDiVe168oQlQxfvDNkL+a4o\nrTrCxRzw0zX0S1bAvejb2QOQNfICVuq15MfFfOqznq3E/ha0aXV7fqh6v44L\n+g5rcW4oWmgrshcNj5Pg+opNjKYX7w08K2jGxbUMRU9IjE4bLcFFpaYolowA\nEQyrTxM0+SEgv7S+pqztL4vFDji4XnnGSVJkxS7uBCPiOEEP87LLfo9sOOJr\n+n+G3fgomxv35LQEcLIcbSPE3qvDh6GFnTgPXVfyG5dgBwDH5rVo4nPaXZid\nFH1u\r\n=ka8h\r\n-----END PGP SIGNATURE-----\r\n"},"main":"lib/index.js","name":"@testing-library/react-hooks","types":"lib/index.d.ts","author":{"name":"Michael Peyper","email":"mpeyper7@gmail.com"},"readme":"
\n

react-hooks-testing-library

\n\n\n \n\n\n

Simple and complete React hooks testing utilities that encourage good testing practices.

\n\n
\n Read The Docs\n
\n
\n\n
\n\n\n[![Build Status](https://img.shields.io/github/workflow/status/testing-library/react-hooks-testing-library/validate?logo=github&style=flat-square)](https://github.com/testing-library/react-hooks-testing-library/actions?query=workflow%3Avalidate)\n[![codecov](https://img.shields.io/codecov/c/github/testing-library/react-hooks-testing-library.svg?style=flat-square)](https://codecov.io/gh/testing-library/react-hooks-testing-library)\n[![version](https://img.shields.io/npm/v/@testing-library/react-hooks.svg?style=flat-square)](https://www.npmjs.com/package/@testing-library/react-hooks)\n[![downloads](https://img.shields.io/npm/dm/@testing-library/react-hooks.svg?style=flat-square)](http://www.npmtrends.com/@testing-library/react-hooks)\n[![MIT License](https://img.shields.io/npm/l/@testing-library/react-hooks.svg?style=flat-square)](https://github.com/testing-library/react-hooks-testing-library/blob/master/LICENSE.md)\n\n[![All Contributors](https://img.shields.io/github/all-contributors/testing-library/react-hooks-testing-library?color=orange&style=flat-square)](#contributors)\n[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)\n[![Code of Conduct](https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square)](https://github.com/testing-library/react-hooks-testing-library/blob/master/CODE_OF_CONDUCT.md)\n[![Netlify Status](https://api.netlify.com/api/v1/badges/9a8f27a5-df38-4910-a248-4908b1ba29a7/deploy-status)](https://app.netlify.com/sites/react-hooks-testing-library/deploys)\n[![Discord](https://img.shields.io/discord/723559267868737556.svg?color=7389D8&labelColor=6A7EC2&logo=discord&logoColor=ffffff&style=flat-square)](https://discord.gg/c6JN9fM)\n\n[![Watch on GitHub](https://img.shields.io/github/watchers/testing-library/react-hooks-testing-library.svg?style=social)](https://github.com/testing-library/react-hooks-testing-library/watchers)\n[![Star on GitHub](https://img.shields.io/github/stars/testing-library/react-hooks-testing-library.svg?style=social)](https://github.com/testing-library/react-hooks-testing-library/stargazers)\n[![Tweet](https://img.shields.io/twitter/url/https/github.com/testing-library/react-hooks-testing-library.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20react-hooks-testing-library%20by%20%40testing-library%20https%3A%2F%2Fgithub.com%2Ftesting-library%2Freact-hooks-testing-library%20%F0%9F%91%8D)\n\n\n## Table of Contents\n\n\n\n\n\n- [The problem](#the-problem)\n- [The solution](#the-solution)\n- [When to use this library](#when-to-use-this-library)\n- [When not to use this library](#when-not-to-use-this-library)\n- [Example](#example)\n - [`useCounter.js`](#usecounterjs)\n - [`useCounter.test.js`](#usecountertestjs)\n- [Installation](#installation)\n - [Peer Dependencies](#peer-dependencies)\n- [API](#api)\n- [Contributors](#contributors)\n- [Issues](#issues)\n - [🐛 Bugs](#-bugs)\n - [💡 Feature Requests](#-feature-requests)\n - [❓ Questions](#-questions)\n- [LICENSE](#license)\n\n\n\n## The problem\n\nYou're writing an awesome custom hook and you want to test it, but as soon as you call it you see\nthe following error:\n\n> Invariant Violation: Hooks can only be called inside the body of a function component.\n\nYou don't really want to write a component solely for testing this hook and have to work out how you\nwere going to trigger all the various ways the hook can be updated, especially given the\ncomplexities of how you've wired the whole thing together.\n\n## The solution\n\nThe `react-hooks-testing-library` allows you to create a simple test harness for React hooks that\nhandles running them within the body of a function component, as well as providing various useful\nutility functions for updating the inputs and retrieving the outputs of your amazing custom hook.\nThis library aims to provide a testing experience as close as possible to natively using your hook\nfrom within a real component.\n\nUsing this library, you do not have to concern yourself with how to construct, render or interact\nwith the react component in order to test your hook. You can just use the hook directly and assert\nthe results.\n\n## When to use this library\n\n1. You're writing a library with one or more custom hooks that are not directly tied to a component\n2. You have a complex hook that is difficult to test through component interactions\n\n## When not to use this library\n\n1. Your hook is defined alongside a component and is only used there\n2. Your hook is easy to test by just testing the components using it\n\n## Example\n\n### `useCounter.js`\n\n```js\nimport { useState, useCallback } from 'react'\n\nfunction useCounter() {\n const [count, setCount] = useState(0)\n\n const increment = useCallback(() => setCount((x) => x + 1), [])\n\n return { count, increment }\n}\n\nexport default useCounter\n```\n\n### `useCounter.test.js`\n\n```js\nimport { renderHook, act } from '@testing-library/react-hooks'\nimport useCounter from './useCounter'\n\ntest('should increment counter', () => {\n const { result } = renderHook(() => useCounter())\n\n act(() => {\n result.current.increment()\n })\n\n expect(result.current.count).toBe(1)\n})\n```\n\nMore advanced usage can be found in the\n[documentation](https://react-hooks-testing-library.com/usage/basic-hooks).\n\n## Installation\n\n```sh\nnpm install --save-dev @testing-library/react-hooks\n```\n\n### Peer Dependencies\n\n`react-hooks-testing-library` does not come bundled with a version of\n[`react`](https://www.npmjs.com/package/react) to allow you to install the specific version you want\nto test against. It also does not come installed with a specific renderer, we currently support\n[`react-test-renderer`](https://www.npmjs.com/package/react-test-renderer) and\n[`react-dom`](https://www.npmjs.com/package/react-dom). You only need to install one of them,\nhowever, if you do have both installed, we will use `react-test-renderer` as the default. For more\ninformation see the [installation docs](https://react-hooks-testing-library.com/#installation).\nGenerally, the installed versions for `react` and the selected renderer should have matching\nversions:\n\n```sh\nnpm install react@^16.9.0\nnpm install --save-dev react-test-renderer@^16.9.0\n```\n\n> **NOTE: The minimum supported version of `react`, `react-test-renderer` and `react-dom` is\n> `^16.9.0`.**\n\n## API\n\nSee the [API reference](https://react-hooks-testing-library.com/reference/api).\n\n## Contributors\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\"\"/
Michael Peyper
💻 📖 🤔 🚇 🚧 💬 ⚠️		\"\"/
otofu-square
💻		\"\"/
Patrick P. Henley
🤔 👀		\"\"/
Matheus Marques
💻		\"\"/
Dhruv Patel
🐛 👀		\"\"/
Nathaniel Tucker
🐛 👀		\"\"/
Sergei Grishchenko
💻 📖 🤔
\"\"/
Josep M Sobrepere
📖		\"\"/
Marcel Tinner
📖		\"\"/
Daniel K.
🐛 💻		\"\"/
Vince Malone
💻		\"\"/
Sebastian Weber
📝		\"\"/
Christian Gill
📖		\"\"/
JavaScript Joe
✅
\"\"/
Sarah Dayan
📦		\"\"/
Roman Gusev
📖		\"\"/
Adam Seckel
💻		\"\"/
keiya sasaki
⚠️		\"\"/
Hu Chen
💻 📖 💡		\"\"/
Josh
📖 💬 💻 🤔 🚧 ⚠️		\"\"/
Na'aman Hirschfeld
💻
\"\"/
Braydon Hall
💻		\"\"/
Jacob M-G Evans
💻 ⚠️		\"\"/
Tiger Abrodi
💻 ⚠️		\"\"/
Amr A.Mohammed
💻 ⚠️		\"\"/
Juhana Jauhiainen
💻		\"\"/
Jens Meindertsma
💻 ⚠️		\"\"/
Marco Moretti
🚇
\"\"/
Martin V.
📖		\"\"/
Erozak
📖		\"\"/
Nick McCurdy
🚧		\"\"/
Arya
📖		\"\"/
numb86
📖		\"\"/
Alex Young
🚧		\"\"/
Ben Lambert
📖
\"\"/
David Cho-Lerat
📖		\"\"/
Evan Harmon
📖		\"\"/
Jason Brown
📖		\"\"/
KahWee Teng
📖		\"\"/
Leonid Shagabutdinov
📖		\"\"/
Levi Butcher
📖		\"\"/
Michele Settepani
📖
\"\"/
Sam
📖		\"\"/
Tanay Pratap
📖		\"\"/
Tom Rees-Herdman
📖		\"\"/
iqbal125
📖		\"\"/
cliffzhaobupt
🚧
\n\n\n\n\n\n\nThis project follows the [all-contributors](https://allcontributors.org/) specification.\nContributions of any kind welcome!\n\n## Issues\n\n_Looking to contribute? Look for the\n[Good First Issue](https://github.com/testing-library/react-hooks-testing-library/issues?utf8=✓&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A\"good+first+issue\"+)\nlabel._\n\n### 🐛 Bugs\n\nPlease file an issue for bugs, missing documentation, or unexpected behavior.\n\n[**See Bugs**](https://github.com/testing-library/react-hooks-testing-library/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc)\n\n### 💡 Feature Requests\n\nPlease file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps\nmaintainers prioritize what to work on.\n\n[**See Feature Requests**](https://github.com/testing-library/react-hooks-testing-library/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen)\n\n### ❓ Questions\n\nFor questions related to using the library, you can\n[raise issue here](https://github.com/testing-library/react-hooks-testing-library/issues/new), or\nvisit a support community:\n\n- [Discord](https://discord.gg/c6JN9fM)\n- [Stack Overflow](https://stackoverflow.com/questions/tagged/react-hooks-testing-library)\n\n## LICENSE\n\nMIT\n","gitHead":"bab38d9c7b7ccd7e9e494ce36f98ed6609278f64","license":"MIT","scripts":{"lint":"kcd-scripts lint","test":"kcd-scripts test","build":"kcd-scripts build --out-dir lib && npm run generate:submodules","setup":"npm install && npm run validate -s","format":"kcd-scripts format","prepare":"npm run build","coverage":"codecov","docs:dev":"docz dev","validate":"kcd-scripts validate","typecheck":"kcd-scripts typecheck","docs:build":"docz build","contributors:add":"all-contributors add","generate:submodules":"ts-node scripts/generate-submodules.ts"},"_npmUser":{"name":"testing-library-bot","email":"testinglibraryoss@gmail.com"},"homepage":"https://github.com/testing-library/react-hooks-testing-library#readme","keywords":["testing","react","hooks","unit","integration"],"repository":{"url":"git+https://github.com/testing-library/react-hooks-testing-library.git","type":"git"},"_npmVersion":"6.14.8","description":"Simple and complete React hooks testing utilities that encourage good testing practices.","directories":{},"maintainers":[{"name":"testing-library-bot","email":"testinglibraryoss@gmail.com"},{"name":"kentcdodds","email":"me@kentcdodds.com"},{"name":"bcarroll22","email":"brandonvcarroll@gmail.com"},{"name":"benmonro","email":"ben.monro@gmail.com"},{"name":"wendell_adriel","email":"wendelladriel.ti@gmail.com"},{"name":"timdeschryver","email":"timdeschryver.dev@gmail.com"},{"name":"patrickhulce","email":"patrick.hulce@gmail.com"},{"name":"dfcook","email":"dfcook@hotmail.com"},{"name":"gpx","email":"polvara@gmail.com"},{"name":"mpeyper","email":"mpeyper7@gmail.com"},{"name":"antoaravinth","email":"anto.aravinth.cse@gmail.com"},{"name":"mihar-22","email":"rahim_alwer@hotmail.com"},{"name":"pago","email":"patrick.gotthardt@trivago.com"},{"name":"cmckinstry","email":"carson.mckinstry@gmail.com"},{"name":"thymikee","email":"thymikee@gmail.com"},{"name":"brrianalexis","email":"brrianalexis.dev@gmail.com"}],"_nodeVersion":"14.15.1","dependencies":{"@types/react":">=16.9.0","@babel/runtime":"^7.12.5","@types/react-dom":">=16.9.0","@types/react-test-renderer":">=16.9.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"docz":"2.3.1","react":"17.0.1","eslint":"7.17.0","codecov":"3.8.1","ts-node":"^9.1.1","prettier":"^2.2.1","react-dom":"^17.0.1","docz-utils":"2.3.0","typescript":"4.1.3","kcd-scripts":"7.5.4","docz-theme-default":"1.2.0","react-test-renderer":"17.0.1","all-contributors-cli":"6.19.0","@typescript-eslint/parser":"^4.9.1","@typescript-eslint/eslint-plugin":"^4.9.1"},"peerDependencies":{"react":">=16.9.0","react-dom":">=16.9.0","react-test-renderer":">=16.9.0"},"peerDependenciesMeta":{"react":{"optional":true},"react-dom":{"optional":true},"react-test-renderer":{"optional":true}},"_npmOperationalInternal":{"tmp":"tmp/react-hooks_5.0.0-beta.9_1610444283796_0.35018081412241187","host":"s3://npm-registry-packages"},"_id":"@testing-library/react-hooks@5.0.0-beta.9","version":"5.0.0-beta.9"}