Skip to content

Commit aeaf3e6

Browse files
authored
Fix typos in useIntervalEffect docs, update migration guide (#1261)
1 parent ee22141 commit aeaf3e6

File tree

4 files changed

+11
-9
lines changed

4 files changed

+11
-9
lines changed

src/__docs__/migrating-from-react-use.story.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import {Meta} from '@storybook/addon-docs'
1+
import { Meta } from '@storybook/addon-docs';
22

33
<Meta title="Migrating from react-use" />
44

@@ -238,7 +238,9 @@ Not implemented yet
238238

239239
#### useInterval
240240

241-
Not implemented yet
241+
Implemented as [useIntervalEffect](/docs/lifecycle-useintervaleffect--example)
242+
243+
No API changes, besides name change.
242244

243245
#### useSpring
244246

@@ -498,7 +500,7 @@ No API changes.
498500

499501
#### useEffectOnce
500502

501-
No plans to implement
503+
Was just an alias for [useMountEffect](/docs/lifecycle-usemounteffect-example) - use that directly instead.
502504

503505
#### useEvent
504506

src/useIntervalEffect/__docs__/story.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
import {Canvas, Meta, Story} from '@storybook/addon-docs';
2-
import {Example} from './example.stories';
3-
import {ImportPath} from '../../__docs__/ImportPath';
1+
import { Canvas, Meta, Story } from '@storybook/addon-docs';
2+
import { Example } from './example.stories';
3+
import { ImportPath } from '../../__docs__/ImportPath';
44

55
<Meta title="Lifecycle/useIntervalEffect" component={Example} />
66

7-
# useInterval
7+
# useIntervalEffect
88

99
Like `setInterval` but in the form of a React hook.
1010

src/useIntervalEffect/__tests__/dom.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { renderHook } from '@testing-library/react-hooks/dom';
22
import { useIntervalEffect } from '../..';
33
import advanceTimersByTime = jest.advanceTimersByTime;
44

5-
describe('useInterval', () => {
5+
describe('useIntervalEffect', () => {
66
beforeAll(() => {
77
jest.useFakeTimers();
88
});

src/useIntervalEffect/__tests__/ssr.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { renderHook } from '@testing-library/react-hooks/server';
22
import { useIntervalEffect } from '../..';
33

4-
describe('useInterval', () => {
4+
describe('useIntervalEffect', () => {
55
it('should be defined', () => {
66
expect(useIntervalEffect).toBeDefined();
77
});

0 commit comments

Comments
 (0)