Skip to content

Commit 11a05a9

Browse files
committed
docs: add some categories to comments for eventual grouping
1 parent f4c4753 commit 11a05a9

File tree

7 files changed

+10
-1
lines changed

7 files changed

+10
-1
lines changed

src/useCallbackRef.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ import { useState } from 'react'
2121
*
2222
* return <div ref={attachRef} />
2323
* ```
24+
*
25+
* @category refs
2426
*/
2527
export default function useCallbackRef<TValue = unknown>(): [
2628
TValue | null,

src/useImmediateUpdateEffect.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ import useStableMemo from './useStableMemo'
1414
* setValue(value)
1515
* }, [value])
1616
* ```
17+
*
18+
* @category effects
1719
*/
1820
function useImmediateUpdateEffect(effect: () => void, deps: DependencyList) {
1921
const firstRef = useRef(true)

src/useIsomorphicEffect.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,7 @@ const isDOM = typeof document !== 'undefined'
1414
* Only useful to avoid the console warning.
1515
*
1616
* PREFER `useEffect` UNLESS YOU KNOW WHAT YOU ARE DOING.
17+
*
18+
* @category effects
1719
*/
1820
export default isDOM || isReactNative ? useLayoutEffect : useEffect

src/useMergedRefs.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ export function mergeRefs<T>(refA?: Ref<T> | null, refB?: Ref<T> | null) {
3333
*
3434
* @param refA A Callback or mutable Ref
3535
* @param refB A Callback or mutable Ref
36+
* @category refs
3637
*/
3738
function useMergedRefs<T>(refA?: Ref<T> | null, refB?: Ref<T> | null) {
3839
return useMemo(() => mergeRefs(refA, refB), [refA, refB])

src/useUpdatedRef.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import { useRef } from 'react'
44
* Returns a ref that is immediately updated with the new value
55
*
66
* @param value The Ref value
7+
* @category refs
78
*/
89
export default function useUpdatedRef<T>(value: T) {
910
const valueRef = useRef<T>(value)

src/useWillUnmount.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { useEffect } from 'react'
55
* Attach a callback that fires when a component unmounts
66
*
77
* @param fn Handler to run when the component unmounts
8+
* @category effects
89
*/
910
export default function useWillUnmount(fn: () => void) {
1011
const onUnmount = useUpdatedRef(fn)

test/useImmediateUpdateEffect.test.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import useImmediateUpdateEffect from '../src/useImmediateUpdateEffect'
22
import { renderHook } from './helpers'
33

44
describe('useImmediateUpdateEffect', () => {
5-
it('should return a function that returns mount state', () => {
5+
it('should run update after value changes', () => {
66
const spy = jest.fn()
77

88
const [, wrapper] = renderHook(

0 commit comments

Comments
 (0)