Fix(types): correct the type of outerRef and innerRef

wellyshen · May 23, 2021 · b7480d0 · b7480d0
1 parent d0a9ddc
commit b7480d0
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 6 deletions.
diff --git a/.changeset/young-phones-happen.md b/.changeset/young-phones-happen.md
@@ -0,0 +1,5 @@
+---
+"react-cool-virtual": patch
+---
+
+Fix(types): correct the type of `outerRef` and `innerRef`
diff --git a/src/types/index.ts b/src/types/index.ts
@@ -1,4 +1,4 @@
-import { RefObject } from "react";
+import { MutableRefObject } from "react";
 
 // Internal
 export interface Measure {
@@ -101,8 +101,8 @@ export interface Options {
 }
 
 export interface Return<O, I> {
-  outerRef: RefObject<O>;
-  innerRef: RefObject<I>;
+  outerRef: MutableRefObject<O | null>;
+  innerRef: MutableRefObject<I | null>;
   items: Item[];
   scrollTo: ScrollTo;
   scrollToItem: ScrollToItem;

diff --git a/src/types/react-cool-virtual.d.ts b/src/types/react-cool-virtual.d.ts
@@ -1,5 +1,5 @@
 declare module "react-cool-virtual" {
-  import { RefObject } from "react";
+  import { MutableRefObject } from "react";
 
   export interface ItemSizeFunction {
     (index: number, width: number): number;
@@ -104,8 +104,8 @@ declare module "react-cool-virtual" {
     O extends HTMLElement = HTMLElement,
     I extends HTMLElement = HTMLElement
   > {
-    outerRef: RefObject<O>;
-    innerRef: RefObject<I>;
+    outerRef: MutableRefObject<O | null>;
+    innerRef: MutableRefObject<I | null>;
     items: Item[];
     scrollTo: ScrollTo;
     scrollToItem: ScrollToItem;