Skip to content

Export options types and renderHook result type #1034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Export options types and renderHook result type #1034

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02272d4
Export options and result types for `renderHook`
evanwalsh Aug 3, 2022
20e3ae6
Rename and export options type for `render`
evanwalsh Aug 3, 2022
cf3c8d0
Add result and option types to `pure` exports
evanwalsh Aug 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/pure.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
import act from './act';
import cleanup from './cleanup';
import fireEvent from './fireEvent';
import render, { RenderResult } from './render';
import render, { RenderResult, RenderOptions } from './render';
import waitFor from './waitFor';
import waitForElementToBeRemoved from './waitForElementToBeRemoved';
import { within, getQueriesForElement } from './within';
import { getDefaultNormalizer } from './matches';
import { renderHook } from './renderHook';
import { renderHook, RenderHookOptions, RenderHookResult } from './renderHook';
import { screen } from './screen';

export type { RenderResult };
export type { RenderOptions, RenderResult };
export type RenderAPI = RenderResult;

export { act };
Expand All @@ -20,5 +20,5 @@ export { waitFor };
export { waitForElementToBeRemoved };
export { within, getQueriesForElement };
export { getDefaultNormalizer };
export { renderHook };
export { renderHook, RenderHookOptions, RenderHookResult };
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Export RenderHookOptions, RenderHookResult as export type next to other export type declarations.

export { screen };
4 changes: 2 additions & 2 deletions src/render.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import debugDeep from './helpers/debugDeep';
import { getQueriesForElement } from './within';
import { setRenderResult } from './screen';

type Options = {
export type RenderOptions = {
wrapper?: React.ComponentType<any>;
createNodeMock?: (element: React.ReactElement) => any;
};
Expand All @@ -24,7 +24,7 @@ export type RenderResult = ReturnType<typeof render>;
*/
export default function render<T>(
component: React.ReactElement<T>,
{ wrapper: Wrapper, createNodeMock }: Options = {}
{ wrapper: Wrapper, createNodeMock }: RenderOptions = {}
) {
const wrap = (innerElement: React.ReactElement) =>
Wrapper ? <Wrapper>{innerElement}</Wrapper> : innerElement;
Expand Down
8 changes: 6 additions & 2 deletions src/renderHook.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,17 @@ import React from 'react';
import type { ComponentType } from 'react';
import render from './render';

interface RenderHookResult<Result, Props> {
export interface RenderHookResult<Result, Props> {
rerender: (props: Props) => void;
result: { current: Result };
unmount: () => void;
}

type RenderHookOptions<Props> = Props extends object | string | number | boolean
export type RenderHookOptions<Props> = Props extends
| object
| string
| number
| boolean
? {
initialProps: Props;
wrapper?: ComponentType<any>;
Expand Down