Changed nextUpdate to waitForNextUpdate

Author: mpeyper

README.md

@@ -154,7 +154,7 @@ Renders a test component that will call the provided `callback`, including any h
 
 - `result` (`object`)
   - `current` (`any`) - the return value of the `callback` function
-- `nextUpdate` (`function`) - returns a `Promise` that resolves the next time the hook renders, commonly when state is updated as the result of a asynchronous action.
+- `waitForNextUpdate` (`function`) - returns a `Promise` that resolves the next time the hook renders, commonly when state is updated as the result of a asynchronous action.
 - `rerender` (`function([newProps])`) - function to rerender the test component including any hooks called in the `callback` function. If `newProps` are passed, the will replace the `initialProps` passed the the `callback` function for future renders.
 - `unmount` (`function()`) - function to unmount the test component, commonly used to trigger cleanup effects for `useEffect` hooks.
 

src/index.js

@@ -10,7 +10,7 @@ function renderHook(callback, { initialProps, ...options } = {}) {
   const result = { current: null }
   const hookProps = { current: initialProps }
   const resolvers = []
-  const nextUpdate = () =>
+  const waitForNextUpdate = () =>
     new Promise((resolve) => {
       resolvers.push(resolve)
     })
@@ -28,7 +28,7 @@ function renderHook(callback, { initialProps, ...options } = {}) {
 
   return {
     result,
-    nextUpdate,
+    waitForNextUpdate,
     unmount,
     rerender: (newProps = hookProps.current) => {
       hookProps.current = newProps

test/asyncHook.test.js

@@ -19,41 +19,41 @@ describe('async hook tests', () => {
   afterEach(cleanup)
 
   test('should wait for next update', async () => {
-    const { result, nextUpdate } = renderHook(() => useName())
+    const { result, waitForNextUpdate } = renderHook(() => useName())
 
     expect(result.current).toBe('nobody')
 
-    await nextUpdate()
+    await waitForNextUpdate()
 
     expect(result.current).toBe('Betty')
   })
 
   test('should wait for multiple updates', async () => {
-    const { result, nextUpdate, rerender } = renderHook(({ prefix }) => useName(prefix), {
+    const { result, waitForNextUpdate, rerender } = renderHook(({ prefix }) => useName(prefix), {
       initialProps: { prefix: 'Mrs.' }
     })
 
     expect(result.current).toBe('nobody')
 
-    await nextUpdate()
+    await waitForNextUpdate()
 
     expect(result.current).toBe('Mrs. Betty')
 
     rerender({ prefix: 'Ms.' })
 
-    await nextUpdate()
+    await waitForNextUpdate()
 
     expect(result.current).toBe('Ms. Betty')
   })
 
   test('should resolve all when updating', async () => {
-    const { result, nextUpdate } = renderHook(({ prefix }) => useName(prefix), {
+    const { result, waitForNextUpdate } = renderHook(({ prefix }) => useName(prefix), {
       initialProps: { prefix: 'Mrs.' }
     })
 
     expect(result.current).toBe('nobody')
 
-    await Promise.all([nextUpdate(), nextUpdate(), nextUpdate()])
+    await Promise.all([waitForNextUpdate(), waitForNextUpdate(), waitForNextUpdate()])
 
     expect(result.current).toBe('Mrs. Betty')
   })

test/typescript/renderHook.ts

@@ -65,11 +65,11 @@ function checkTypesWhenHookReturnsVoid() {
   const _rerender: () => void = rerender
 }
 
-async function checkTypesForNextUpdate() {
-  const { nextUpdate } = renderHook(() => {})
+async function checkTypesForWaitForNextUpdate() {
+  const { waitForNextUpdate } = renderHook(() => {})
 
-  await nextUpdate()
+  await waitForNextUpdate()
 
   // check type
-  const _nextUpdate: () => Promise<void> = nextUpdate
+  const _waitForNextUpdate: () => Promise<void> = waitForNextUpdate
 }

typings/index.d.ts

@@ -9,7 +9,7 @@ export function renderHook<P, R>(
   readonly result: {
     current: R
   }
-  readonly nextUpdate: () => Promise<void>
+  readonly waitForNextUpdate: () => Promise<void>
   readonly unmount: RenderResult['unmount']
   readonly rerender: (hookProps?: P) => void
 }