rename useImperativeMethods -> useImperativeHandle (#14565)

Sunil Pai · web-flow · commit b4ad8e947150 · 2019-01-10T13:37:50.000Z
diff --git a/packages/react-debug-tools/src/ReactDebugHooks.js b/packages/react-debug-tools/src/ReactDebugHooks.js
@@ -54,7 +54,7 @@ function getPrimitiveStackCache(): Map<string, Array<any>> {
 Dispatcher.useRef(null);
 Dispatcher.useLayoutEffect(() => {});
 Dispatcher.useEffect(() => {});
- Dispatcher.useImperativeMethods(undefined, () => null);
+ Dispatcher.useImperativeHandle(undefined, () => null);
 Dispatcher.useCallback(() => {});
 Dispatcher.useMemo(() => null);
 } finally {
@@ -159,7 +159,7 @@ function useEffect(
 hookLog.push({primitive: 'Effect', stackError: new Error(), value: create});
 }
 
-function useImperativeMethods<T>(
+function useImperativeHandle<T>(
 ref: {current: T | null} | ((inst: T | null) => mixed) | null | void,
 create: () => T,
 inputs: Array<mixed> | void | null,
@@ -174,7 +174,7 @@ function useImperativeMethods<T>(
 instance = ref.current;
 }
 hookLog.push({
- primitive: 'ImperativeMethods',
+ primitive: 'ImperativeHandle',
 stackError: new Error(),
 value: instance,
 });
@@ -205,7 +205,7 @@ const Dispatcher = {
 useCallback,
 useContext,
 useEffect,
- useImperativeMethods,
+ useImperativeHandle,
 useLayoutEffect,
 useMemo,
 useReducer,
diff --git a/packages/react-debug-tools/src/__tests__/ReactHooksInspectionIntegration-test.internal.js b/packages/react-debug-tools/src/__tests__/ReactHooksInspectionIntegration-test.internal.js
@@ -82,7 +82,7 @@ describe('ReactHooksInspectionIntergration', () => {
 React.useLayoutEffect(effect);
 React.useEffect(effect);
 
- React.useImperativeMethods(
+ React.useImperativeHandle(
 outsideRef,
 () => {
 // Return a function so that jest treats them as non-equal.
@@ -118,7 +118,7 @@ describe('ReactHooksInspectionIntergration', () => {
 {name: 'Ref', value: 'c', subHooks: []},
 {name: 'LayoutEffect', value: effect, subHooks: []},
 {name: 'Effect', value: effect, subHooks: []},
- {name: 'ImperativeMethods', value: outsideRef.current, subHooks: []},
+ {name: 'ImperativeHandle', value: outsideRef.current, subHooks: []},
 {name: 'Memo', value: 'ab', subHooks: []},
 {name: 'Callback', value: updateStates, subHooks: []},
 ]);
@@ -134,7 +134,7 @@ describe('ReactHooksInspectionIntergration', () => {
 {name: 'Ref', value: 'C', subHooks: []},
 {name: 'LayoutEffect', value: effect, subHooks: []},
 {name: 'Effect', value: effect, subHooks: []},
- {name: 'ImperativeMethods', value: outsideRef.current, subHooks: []},
+ {name: 'ImperativeHandle', value: outsideRef.current, subHooks: []},
 {name: 'Memo', value: 'Ab', subHooks: []},
 {name: 'Callback', value: updateStates, subHooks: []},
 ]);
@@ -165,7 +165,7 @@ describe('ReactHooksInspectionIntergration', () => {
 it('should inspect forwardRef', () => {
 let obj = function() {};
 let Foo = React.forwardRef(function(props, ref) {
- React.useImperativeMethods(ref, () => obj);
+ React.useImperativeHandle(ref, () => obj);
 return <div />;
 });
 let ref = React.createRef();
@@ -174,7 +174,7 @@ describe('ReactHooksInspectionIntergration', () => {
 let childFiber = renderer.root.findByType(Foo)._currentFiber();
 let tree = ReactDebugTools.inspectHooksOfFiber(childFiber);
 expect(tree).toEqual([
- {name: 'ImperativeMethods', value: obj, subHooks: []},
+ {name: 'ImperativeHandle', value: obj, subHooks: []},
 ]);
 });
 
diff --git a/packages/react-dom/src/__tests__/ReactDOMServerIntegrationHooks-test.internal.js b/packages/react-dom/src/__tests__/ReactDOMServerIntegrationHooks-test.internal.js
@@ -24,7 +24,7 @@ let useContext;
 let useCallback;
 let useMemo;
 let useRef;
-let useImperativeMethods;
+let useImperativeHandle;
 let useLayoutEffect;
 let forwardRef;
 let yieldedValues;
@@ -48,7 +48,7 @@ function initModules() {
 useCallback = React.useCallback;
 useMemo = React.useMemo;
 useRef = React.useRef;
- useImperativeMethods = React.useImperativeMethods;
+ useImperativeHandle = React.useImperativeHandle;
 useLayoutEffect = React.useLayoutEffect;
 forwardRef = React.forwardRef;
 
@@ -529,10 +529,10 @@ describe('ReactDOMServerHooks', () => {
 });
 });
 
- describe('useImperativeMethods', () => {
+ describe('useImperativeHandle', () => {
 it('should not be invoked on the server', async () => {
 function Counter(props, ref) {
- useImperativeMethods(ref, () => {
+ useImperativeHandle(ref, () => {
 throw new Error('should not be invoked');
 });
 return <Text text={props.label + ': ' + ref.current} />;
diff --git a/packages/react-dom/src/server/ReactPartialRendererHooks.js b/packages/react-dom/src/server/ReactPartialRendererHooks.js
@@ -347,8 +347,8 @@ export const Dispatcher = {
 useLayoutEffect,
 // Callbacks are passed as they are in the server environment.
 useCallback: identity,
- // useImperativeMethods is not run in the server environment
- useImperativeMethods: noop,
+ // useImperativeHandle is not run in the server environment
+ useImperativeHandle: noop,
 // Effects are not run in the server environment.
 useEffect: noop,
 };
diff --git a/packages/react-reconciler/src/ReactFiberDispatcher.js b/packages/react-reconciler/src/ReactFiberDispatcher.js
@@ -12,7 +12,7 @@ import {
 useCallback,
 useContext,
 useEffect,
- useImperativeMethods,
+ useImperativeHandle,
 useLayoutEffect,
 useMemo,
 useReducer,
@@ -25,7 +25,7 @@ export const Dispatcher = {
 useCallback,
 useContext,
 useEffect,
- useImperativeMethods,
+ useImperativeHandle,
 useLayoutEffect,
 useMemo,
 useReducer,
diff --git a/packages/react-reconciler/src/ReactFiberHooks.js b/packages/react-reconciler/src/ReactFiberHooks.js
@@ -557,7 +557,7 @@ function useEffectImpl(fiberEffectTag, hookEffectTag, create, inputs): void {
 );
 }
 
-export function useImperativeMethods<T>(
+export function useImperativeHandle<T>(
 ref: {current: T | null} | ((inst: T | null) => mixed) | null | void,
 create: () => T,
 inputs: Array<mixed> | void | null,
diff --git a/packages/react-reconciler/src/__tests__/ReactHooksWithNoopRenderer-test.internal.js b/packages/react-reconciler/src/__tests__/ReactHooksWithNoopRenderer-test.internal.js
@@ -23,7 +23,7 @@ let useLayoutEffect;
 let useCallback;
 let useMemo;
 let useRef;
-let useImperativeMethods;
+let useImperativeHandle;
 let forwardRef;
 let flushPassiveEffects;
 let memo;
@@ -71,7 +71,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 useCallback = React.useCallback;
 useMemo = React.useMemo;
 useRef = React.useRef;
- useImperativeMethods = React.useImperativeMethods;
+ useImperativeHandle = React.useImperativeHandle;
 forwardRef = React.forwardRef;
 memo = React.memo;
 });
@@ -88,7 +88,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 it('resumes after an interruption', () => {
 function Counter(props, ref) {
 const [count, updateCount] = useState(0);
- useImperativeMethods(ref, () => ({updateCount}));
+ useImperativeHandle(ref, () => ({updateCount}));
 return <Text text={props.label + ': ' + count} />;
 }
 Counter = forwardRef(Counter);
@@ -172,7 +172,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 it('simple mount and update', () => {
 function Counter(props, ref) {
 const [count, updateCount] = useState(0);
- useImperativeMethods(ref, () => ({updateCount}));
+ useImperativeHandle(ref, () => ({updateCount}));
 return <Text text={'Count: ' + count} />;
 }
 Counter = forwardRef(Counter);
@@ -196,7 +196,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 ReactNoop.yield('getInitialState');
 return props.initialState;
 });
- useImperativeMethods(ref, () => ({updateCount}));
+ useImperativeHandle(ref, () => ({updateCount}));
 return <Text text={'Count: ' + count} />;
 }
 Counter = forwardRef(Counter);
@@ -214,7 +214,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 function Counter(props, ref) {
 const [count, updateCount] = useState(0);
 const [label, updateLabel] = useState('Count');
- useImperativeMethods(ref, () => ({updateCount, updateLabel}));
+ useImperativeHandle(ref, () => ({updateCount, updateLabel}));
 return <Text text={label + ': ' + count} />;
 }
 Counter = forwardRef(Counter);
@@ -444,7 +444,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 function Counter({row: newRow}, ref) {
 let [reducer, setReducer] = useState(() => reducerA);
 let [count, dispatch] = useReducer(reducer, 0);
- useImperativeMethods(ref, () => ({dispatch}));
+ useImperativeHandle(ref, () => ({dispatch}));
 if (count < 20) {
 dispatch('increment');
 // Swap reducers each time we increment
@@ -505,7 +505,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 
 function Counter(props, ref) {
 const [count, dispatch] = useReducer(reducer, 0);
- useImperativeMethods(ref, () => ({dispatch}));
+ useImperativeHandle(ref, () => ({dispatch}));
 return <Text text={'Count: ' + count} />;
 }
 Counter = forwardRef(Counter);
@@ -546,7 +546,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 
 function Counter(props, ref) {
 const [count, dispatch] = useReducer(reducer, 0, initialAction);
- useImperativeMethods(ref, () => ({dispatch}));
+ useImperativeHandle(ref, () => ({dispatch}));
 return <Text text={'Count: ' + count} />;
 }
 Counter = forwardRef(Counter);
@@ -576,7 +576,7 @@ describe('ReactHooksWithNoopRenderer', () => {
 
 function Counter(props, ref) {
 const [count, dispatch] = useReducer(reducer, 0);
- useImperativeMethods(ref, () => ({dispatch}));
+ useImperativeHandle(ref, () => ({dispatch}));
 return <Text text={'Count: ' + count} />;
 }
 
diff --git a/packages/react/src/React.js b/packages/react/src/React.js
@@ -32,7 +32,7 @@ import {
 useCallback,
 useContext,
 useEffect,
- useImperativeMethods,
+ useImperativeHandle,
 useLayoutEffect,
 useMemo,
 useReducer,
@@ -98,7 +98,7 @@ if (enableHooks) {
 React.useCallback = useCallback;
 React.useContext = useContext;
 React.useEffect = useEffect;
- React.useImperativeMethods = useImperativeMethods;
+ React.useImperativeHandle = useImperativeHandle;
 React.useLayoutEffect = useLayoutEffect;
 React.useMemo = useMemo;
 React.useReducer = useReducer;
diff --git a/packages/react/src/ReactHooks.js b/packages/react/src/ReactHooks.js
@@ -102,11 +102,11 @@ export function useMemo(
 return dispatcher.useMemo(create, inputs);
 }
 
-export function useImperativeMethods<T>(
+export function useImperativeHandle<T>(
 ref: {current: T | null} | ((inst: T | null) => mixed) | null | void,
 create: () => T,
 inputs: Array<mixed> | void | null,
 ): void {
 const dispatcher = resolveDispatcher();
- return dispatcher.useImperativeMethods(ref, create, inputs);
+ return dispatcher.useImperativeHandle(ref, create, inputs);
 }

-Original file line number
+Diff line change
 React.useLayoutEffect(effect);
 React.useEffect(effect);
 -React.useImperativeMethods(
 +React.useImperativeHandle(
 outsideRef,
 ()=>{
 // Return a function so that jest treats them as non-equal.
 {name: 'Ref',value: 'c',subHooks: []},
 {name: 'LayoutEffect',value: effect,subHooks: []},
 {name: 'Effect',value: effect,subHooks: []},
 -{name: 'ImperativeMethods',value: outsideRef.current,subHooks: []},
 +{name: 'ImperativeHandle',value: outsideRef.current,subHooks: []},
 {name: 'Memo',value: 'ab',subHooks: []},
 {name: 'Callback',value: updateStates,subHooks: []},
 ]);
 {name: 'Ref',value: 'C',subHooks: []},
 {name: 'LayoutEffect',value: effect,subHooks: []},
 {name: 'Effect',value: effect,subHooks: []},
 -{name: 'ImperativeMethods',value: outsideRef.current,subHooks: []},
 +{name: 'ImperativeHandle',value: outsideRef.current,subHooks: []},
 {name: 'Memo',value: 'Ab',subHooks: []},
 {name: 'Callback',value: updateStates,subHooks: []},
 ]);
 it('should inspect forwardRef',()=>{
 letobj=function(){};
 letFoo=React.forwardRef(function(props,ref){
 -React.useImperativeMethods(ref,()=>obj);
 +React.useImperativeHandle(ref,()=>obj);
 return<div/>;
 });
 letref=React.createRef();
 letchildFiber=renderer.root.findByType(Foo)._currentFiber();
 lettree=ReactDebugTools.inspectHooksOfFiber(childFiber);
 expect(tree).toEqual([
 -{name: 'ImperativeMethods',value: obj,subHooks: []},
 +{name: 'ImperativeHandle',value: obj,subHooks: []},
 ]);
 });
-Original file line number
+Diff line change
 letuseCallback;
 letuseMemo;
 letuseRef;
 -letuseImperativeMethods;
 +letuseImperativeHandle;
 letuseLayoutEffect;
 letforwardRef;
 letyieldedValues;
 useCallback=React.useCallback;
 useMemo=React.useMemo;
 useRef=React.useRef;
 -useImperativeMethods=React.useImperativeMethods;
 +useImperativeHandle=React.useImperativeHandle;
 useLayoutEffect=React.useLayoutEffect;
 forwardRef=React.forwardRef;
 });
 });
 -describe('useImperativeMethods',()=>{
 +describe('useImperativeHandle',()=>{
 it('should not be invoked on the server',async()=>{
 functionCounter(props,ref){
 -useImperativeMethods(ref,()=>{
 +useImperativeHandle(ref,()=>{
 thrownewError('should not be invoked');
 });
 return<Texttext={props.label+': '+ref.current}/>;
Original file line number	Diff line number	Diff line change
`@@ -557,7 +557,7 @@ function useEffectImpl(fiberEffectTag, hookEffectTag, create, inputs): void {`
`557`	`557`	`);`
`558`	`558`	`}`
`559`	`559`
`560`		`-export function useImperativeMethods<T>(`
	`560`	`+export function useImperativeHandle<T>(`
`561`	`561`	`ref: {current: T\|null} \| ((inst: T \| null) =>mixed)\|null\|void,`
`562`	`562`	`create: ()=>T,`
`563`	`563`	`inputs: Array<mixed> \| void \| null,`
-Original file line number
+Diff line change
 letuseCallback;
 letuseMemo;
 letuseRef;
 -letuseImperativeMethods;
 +letuseImperativeHandle;
 letforwardRef;
 letflushPassiveEffects;
 letmemo;
 useCallback=React.useCallback;
 useMemo=React.useMemo;
 useRef=React.useRef;
 -useImperativeMethods=React.useImperativeMethods;
 +useImperativeHandle=React.useImperativeHandle;
 forwardRef=React.forwardRef;
 memo=React.memo;
 });
 it('resumes after an interruption',()=>{
 functionCounter(props,ref){
 const[count,updateCount]=useState(0);
 -useImperativeMethods(ref,()=>({updateCount}));
 +useImperativeHandle(ref,()=>({updateCount}));
 return<Texttext={props.label+': '+count}/>;
+}
 Counter=forwardRef(Counter);
 it('simple mount and update',()=>{
 functionCounter(props,ref){
 const[count,updateCount]=useState(0);
 -useImperativeMethods(ref,()=>({updateCount}));
 +useImperativeHandle(ref,()=>({updateCount}));
 return<Texttext={'Count: '+count}/>;
+}
 Counter=forwardRef(Counter);
 ReactNoop.yield('getInitialState');
 returnprops.initialState;
 });
 -useImperativeMethods(ref,()=>({updateCount}));
 +useImperativeHandle(ref,()=>({updateCount}));
 return<Texttext={'Count: '+count}/>;
+}
 Counter=forwardRef(Counter);
 functionCounter(props,ref){
 const[count,updateCount]=useState(0);
 const[label,updateLabel]=useState('Count');
 -useImperativeMethods(ref,()=>({updateCount, updateLabel}));
 +useImperativeHandle(ref,()=>({updateCount, updateLabel}));
 return<Texttext={label+': '+count}/>;
+}
 Counter=forwardRef(Counter);
 functionCounter({row: newRow},ref){
 let[reducer,setReducer]=useState(()=>reducerA);
 let[count,dispatch]=useReducer(reducer,0);
 -useImperativeMethods(ref,()=>({dispatch}));
 +useImperativeHandle(ref,()=>({dispatch}));
 if(count<20){
 dispatch('increment');
 // Swap reducers each time we increment
 functionCounter(props,ref){
 const[count,dispatch]=useReducer(reducer,0);
 -useImperativeMethods(ref,()=>({dispatch}));
 +useImperativeHandle(ref,()=>({dispatch}));
 return<Texttext={'Count: '+count}/>;
+}
 Counter=forwardRef(Counter);
 functionCounter(props,ref){
 const[count,dispatch]=useReducer(reducer,0,initialAction);
 -useImperativeMethods(ref,()=>({dispatch}));
 +useImperativeHandle(ref,()=>({dispatch}));
 return<Texttext={'Count: '+count}/>;
+}
 Counter=forwardRef(Counter);
 functionCounter(props,ref){
 const[count,dispatch]=useReducer(reducer,0);
 -useImperativeMethods(ref,()=>({dispatch}));
 +useImperativeHandle(ref,()=>({dispatch}));
 return<Texttext={'Count: '+count}/>;
+}
Original file line number	Diff line number	Diff line change
`@@ -102,11 +102,11 @@ export function useMemo(`
`102`	`102`	`returndispatcher.useMemo(create,inputs);`
`103`	`103`	`}`
`104`	`104`
`105`		`-export function useImperativeMethods<T>(`
	`105`	`+export function useImperativeHandle<T>(`
`106`	`106`	`ref: {current: T\|null} \| ((inst: T \| null) =>mixed)\|null\|void,`
`107`	`107`	`create: ()=>T,`
`108`	`108`	`inputs: Array<mixed> \| void \| null,`
`109`	`109`	`): void {`
`110`	`110`	`constdispatcher=resolveDispatcher();`
`111`		`-returndispatcher.useImperativeMethods(ref,create,inputs);`
	`111`	`+returndispatcher.useImperativeHandle(ref,create,inputs);`
`112`	`112`	`}`