Skip to content

Commit c7b1585

Browse files
committed
refactor(rename): useRender -> useUpdate
1 parent b689801 commit c7b1585

File tree

5 files changed

+37
-37
lines changed

5 files changed

+37
-37
lines changed

README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ yarn add @react-cmpt/hooks
2424
- [useInterval](#useInterval)
2525
- [useLoadImg](#useLoadImg)
2626
- [useMountedState](#useMountedState)
27-
- [useRender](#useRender)
2827
- [useThrottle](#useThrottle)
2928
- [useThrottleFn](#useThrottleFn)
3029
- [useUnmount](#useUnmount)
30+
- [useUpdate](#useUpdate)
3131
- [useUpdateEffect](#useUpdateEffect)
3232

3333
### useAsyncClick
@@ -313,29 +313,6 @@ const Demo = () => {
313313
};
314314
```
315315

316-
### useRender
317-
318-
Re-render components
319-
320-
| return | type | default | explain |
321-
| -------- | -------- | ------- | ----------------- |
322-
| rerender | function | | rerender callback |
323-
324-
```tsx
325-
import { useRender } from "@react-cmpt/hooks";
326-
327-
const Demo = () => {
328-
const rerender = useRender();
329-
330-
return (
331-
<>
332-
<div>Date: {Date.now()}</div>
333-
<button onClick={rerender}>Update</button>
334-
</>
335-
);
336-
};
337-
```
338-
339316
### useThrottle
340317

341318
throttled value
@@ -461,6 +438,29 @@ const Demo = () => {
461438
};
462439
```
463440

441+
### useUpdate
442+
443+
Re-render components
444+
445+
| return | type | default | explain |
446+
| -------- | -------- | ------- | ----------------- |
447+
| rerender | function | | rerender callback |
448+
449+
```tsx
450+
import { useUpdate } from "@react-cmpt/hooks";
451+
452+
const Demo = () => {
453+
const rerender = useUpdate();
454+
455+
return (
456+
<>
457+
<div>Date: {Date.now()}</div>
458+
<button onClick={rerender}>Update</button>
459+
</>
460+
);
461+
};
462+
```
463+
464464
### useUpdateEffect
465465

466466
React.useEffect cancel the first mount trigger

src/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import useDeepEffect from "./useDeepEffect";
77
import useInterval from "./useInterval";
88
import useLoadImg from "./useLoadImg";
99
import useMountedState from "./useMountedState";
10-
import useRender from "./useRender";
10+
import useUpdate from "./useUpdate";
1111
import useThrottle from "./useThrottle";
1212
import useThrottleFn from "./useThrottleFn";
1313
import useUnmount from "./useUnmount";
@@ -23,7 +23,7 @@ export {
2323
useInterval,
2424
useLoadImg,
2525
useMountedState,
26-
useRender,
26+
useUpdate,
2727
useThrottle,
2828
useThrottleFn,
2929
useUnmount,

src/useRender.ts

Lines changed: 0 additions & 7 deletions
This file was deleted.

src/useUpdate.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { useReducer } from "react";
2+
3+
export default function useUpdate(): () => void {
4+
const [, rerender] = useReducer((num: number) => (num + 1) % 1000000, 0);
5+
6+
return rerender;
7+
}

tests/useRender.test.ts renamed to tests/useUpdate.test.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
import { act, renderHook } from "@testing-library/react-hooks";
22
import { useEffect } from "react";
33

4-
import useRender from "../src/useRender";
4+
import useUpdate from "../src/useUpdate";
55

66
describe("useUnmount", () => {
77
it("should be defined", () => {
8-
expect(useRender).toBeDefined();
8+
expect(useUpdate).toBeDefined();
99
});
1010

1111
it("return type (function)", () => {
12-
const { result } = renderHook(() => useRender());
12+
const { result } = renderHook(() => useUpdate());
1313

1414
expect(result.current).toBeInstanceOf(Function);
1515
});
@@ -20,7 +20,7 @@ describe("useUnmount", () => {
2020

2121
const { result, rerender } = renderHook(() => {
2222
renderTimes += 1;
23-
const rerender = useRender();
23+
const rerender = useUpdate();
2424

2525
useEffect(() => {
2626
fnUpdateTimes += 1;

0 commit comments

Comments
 (0)