Skip to content

Commit 2fba7ba

Browse files
committed
reorder overload
1 parent 1eaa621 commit 2fba7ba

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

src/useIntersectionObserver.ts

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,29 @@ import useEventCallback from './useEventCallback'
66

77
/**
88
* Setup an [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver) on
9-
* a DOM Element. This overload does not trigger component updates when receiving new
10-
* entries. This allows for finer grained performance optimizations by the consumer.
9+
* a DOM Element that returns it's entries as they arrive.
1110
*
1211
* @param element The DOM element to observe
13-
* @param callback A listener for intersection updates.
1412
* @param init IntersectionObserver options
1513
*/
1614
function useIntersectionObserver<TElement extends Element>(
1715
element: TElement | null | undefined,
18-
callback: IntersectionObserverCallback,
1916
options: IntersectionObserverInit,
20-
): void
17+
): IntersectionObserverEntry[]
2118
/**
2219
* Setup an [`IntersectionObserver`](https://developer.mozilla.org/en-US/docs/Web/API/IntersectionObserver) on
23-
* a DOM Element that returns it's entries as they arrive.
20+
* a DOM Element. This overload does not trigger component updates when receiving new
21+
* entries. This allows for finer grained performance optimizations by the consumer.
2422
*
2523
* @param element The DOM element to observe
24+
* @param callback A listener for intersection updates.
2625
* @param init IntersectionObserver options
2726
*/
2827
function useIntersectionObserver<TElement extends Element>(
2928
element: TElement | null | undefined,
29+
callback: IntersectionObserverCallback,
3030
options: IntersectionObserverInit,
31-
): IntersectionObserverEntry[]
31+
): void
3232
function useIntersectionObserver<TElement extends Element>(
3333
element: TElement | null | undefined,
3434
callbackOrOptions: IntersectionObserverCallback | IntersectionObserverInit,

src/useMutationObserver.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ function isDepsEqual(
1717
* Observe mutations on a DOM node or tree of DOM nodes.
1818
* Depends on the `MutationObserver` api.
1919
*
20-
* ```ts
20+
* ```tsx
2121
* const [element, attachRef] = useCallbackRef(null);
2222
*
2323
* useMutationObserver(element, { subtree: true }, (records) => {
@@ -42,7 +42,7 @@ function useMutationObserver(
4242
* Observe mutations on a DOM node or tree of DOM nodes.
4343
* use a `MutationObserver` and return records as the are received.
4444
*
45-
* ```ts
45+
* ```tsx
4646
* const [element, attachRef] = useCallbackRef(null);
4747
*
4848
* const records = useMutationObserver(element, { subtree: true });

0 commit comments

Comments
 (0)