Fix typos in useIntervalEffect docs, update migration guide (#1261)

react-hookz · May 24, 2023 · aeaf3e6 · aeaf3e6
1 parent ee22141
commit aeaf3e6
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 9 deletions.
diff --git a/src/__docs__/migrating-from-react-use.story.mdx b/src/__docs__/migrating-from-react-use.story.mdx
@@ -1,4 +1,4 @@
-import {Meta} from '@storybook/addon-docs'
+import { Meta } from '@storybook/addon-docs';
 
 <Meta title="Migrating from react-use" />
 
@@ -238,7 +238,9 @@ Not implemented yet
 
 #### useInterval
 
-Not implemented yet
+Implemented as [useIntervalEffect](/docs/lifecycle-useintervaleffect--example)
+
+No API changes, besides name change.
 
 #### useSpring
 
@@ -498,7 +500,7 @@ No API changes.
 
 #### useEffectOnce
 
-No plans to implement
+Was just an alias for [useMountEffect](/docs/lifecycle-usemounteffect-example) - use that directly instead.
 
 #### useEvent
 

diff --git a/src/useIntervalEffect/__docs__/story.mdx b/src/useIntervalEffect/__docs__/story.mdx
@@ -1,10 +1,10 @@
-import {Canvas, Meta, Story} from '@storybook/addon-docs';
-import {Example} from './example.stories';
-import {ImportPath} from '../../__docs__/ImportPath';
+import { Canvas, Meta, Story } from '@storybook/addon-docs';
+import { Example } from './example.stories';
+import { ImportPath } from '../../__docs__/ImportPath';
 
 <Meta title="Lifecycle/useIntervalEffect" component={Example} />
 
-# useInterval
+# useIntervalEffect
 
 Like `setInterval` but in the form of a React hook.
 

diff --git a/src/useIntervalEffect/__tests__/dom.ts b/src/useIntervalEffect/__tests__/dom.ts
@@ -2,7 +2,7 @@ import { renderHook } from '@testing-library/react-hooks/dom';
 import { useIntervalEffect } from '../..';
 import advanceTimersByTime = jest.advanceTimersByTime;
 
-describe('useInterval', () => {
+describe('useIntervalEffect', () => {
   beforeAll(() => {
     jest.useFakeTimers();
   });

diff --git a/src/useIntervalEffect/__tests__/ssr.ts b/src/useIntervalEffect/__tests__/ssr.ts
@@ -1,7 +1,7 @@
 import { renderHook } from '@testing-library/react-hooks/server';
 import { useIntervalEffect } from '../..';
 
-describe('useInterval', () => {
+describe('useIntervalEffect', () => {
   it('should be defined', () => {
     expect(useIntervalEffect).toBeDefined();
   });