Commit 3dcd8a9

authored

fix: Add support for exactOptionalPropertyTypes in TypeScript (#1351)

1 parent 7a28fa9 commit 3dcd8a9Copy full SHA for 3dcd8a9

File tree

3 files changed

+20

-13

lines changed

types

3 files changed

+20

-13

lines changed

`‎types/index.d.ts‎`

Lines changed: 13 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,10 @@ export type RenderResult<`
`36`	`36`	`baseElement?:`
`37`	`37`	`\| RendererableContainer`
`38`	`38`	`\| HydrateableContainer`
`39`		`- \| Array<RendererableContainer \| HydrateableContainer>,`
`40`		`- maxLength?: number,`
`41`		`- options?: prettyFormat.OptionsReceived,`
	`39`	`+ \| Array<RendererableContainer \| HydrateableContainer>`
	`40`	`+ \| undefined,`
	`41`	`+ maxLength?: number \| undefined,`
	`42`	`+ options?: prettyFormat.OptionsReceived \| undefined,`
`42`	`43`	`) => void`
`43`	`44`	`rerender: (ui: React.ReactNode) => void`
`44`	`45`	`unmount: () => void`
`@@ -97,40 +98,40 @@ export interface RenderOptions<`
`97`	`98`	`*`
`98`	`99`	`* @see https://testing-library.com/docs/react-testing-library/api/#container`
`99`	`100`	`*/`
`100`		`- container?: Container`
	`101`	`+ container?: Container\|undefined`
`101`	`102`	`/**`
`102`	`103`	* Defaults to the container if the container is specified. Otherwise `document.body` is used for the default. This is used as
`103`	`104`	* the base element for the queries as well as what is printed when you use `debug()`.
`104`	`105`	`*`
`105`	`106`	`* @see https://testing-library.com/docs/react-testing-library/api/#baseelement`
`106`	`107`	`*/`
`107`		`- baseElement?: BaseElement`
	`108`	`+ baseElement?: BaseElement\|undefined`
`108`	`109`	`/**`
`109`	`110`	* If `hydrate` is set to `true`, then it will render with `ReactDOM.hydrate`. This may be useful if you are using server-side
`110`	`111`	`* rendering and use ReactDOM.hydrate to mount your components.`
`111`	`112`	`*`
`112`	`113`	`* @see https://testing-library.com/docs/react-testing-library/api/#hydrate)`
`113`	`114`	`*/`
`114`		`- hydrate?: boolean`
	`115`	`+ hydrate?: boolean\|undefined`
`115`	`116`	`/**`
`116`	`117`	`* Only works if used with React 18.`
`117`	`118`	* Set to `true` if you want to force synchronous `ReactDOM.render`.
`118`	`119`	* Otherwise `render` will default to concurrent React if available.
`119`	`120`	`*/`
`120`		`- legacyRoot?: boolean`
	`121`	`+ legacyRoot?: boolean\|undefined`
`121`	`122`	`/**`
`122`	`123`	`* Queries to bind. Overrides the default set from DOM Testing Library unless merged.`
`123`	`124`	`*`
`124`	`125`	`* @see https://testing-library.com/docs/react-testing-library/api/#queries`
`125`	`126`	`*/`
`126`		`- queries?: Q`
	`127`	`+ queries?: Q\|undefined`
`127`	`128`	`/**`
`128`	`129`	`* Pass a React Component as the wrapper option to have it rendered around the inner element. This is most useful for creating`
`129`	`130`	`* reusable custom render functions for common data providers. See setup for examples.`
`130`	`131`	`*`
`131`	`132`	`* @see https://testing-library.com/docs/react-testing-library/api/#wrapper`
`132`	`133`	`*/`
`133`		`- wrapper?: React.JSXElementConstructor<{children: React.ReactNode}>`
	`134`	`+ wrapper?: React.JSXElementConstructor<{children: React.ReactNode}>\|undefined`
`134`	`135`	`}`
`135`	`136`
`136`	`137`	`type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>`
`@@ -148,7 +149,7 @@ export function render<`
`148`	`149`	`): RenderResult<Q, Container, BaseElement>`
`149`	`150`	`export function render(`
`150`	`151`	`ui: React.ReactNode,`
`151`		`- options?: Omit<RenderOptions, 'queries'>,`
	`152`	`+ options?: Omit<RenderOptions, 'queries'>\|undefined,`
`152`	`153`	`): RenderResult`
`153`	`154`
`154`	`155`	`export interface RenderHookResult<Result, Props> {`
`@@ -223,7 +224,7 @@ export interface RenderHookOptions<`
`223`	`224`	`* The argument passed to the renderHook callback. Can be useful if you plan`
`224`	`225`	`* to use the rerender utility to change the values passed to your hook.`
`225`	`226`	`*/`
`226`		`- initialProps?: Props`
	`227`	`+ initialProps?: Props\|undefined`
`227`	`228`	`}`
`228`	`229`
`229`	`230`	`/**`
`@@ -238,7 +239,7 @@ export function renderHook<`
`238`	`239`	`BaseElement extends RendererableContainer \| HydrateableContainer = Container,`
`239`	`240`	`>(`
`240`	`241`	`render: (initialProps: Props) => Result,`
`241`		`- options?: RenderHookOptions<Props, Q, Container, BaseElement>,`
	`242`	`+ options?: RenderHookOptions<Props, Q, Container, BaseElement>\|undefined,`
`242`	`243`	`): RenderHookResult<Result, Props>`
`243`	`244`
`244`	`245`	`/**`

`‎types/test.tsx‎`

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,12 @@ export function wrappedRender(`
`132`	`132`	`return <div>{children}</div>`
`133`	`133`	`}`
`134`	`134`
`135`		`- return pure.render(ui, {wrapper: Wrapper, ...options})`
	`135`	`+ return pure.render(ui, {`
	`136`	`+ wrapper: Wrapper,`
	`137`	`+ // testing exactOptionalPropertyTypes comaptibility`
	`138`	`+ hydrate: options?.hydrate,`
	`139`	`+ ...options,`
	`140`	`+ })`
`136`	`141`	`}`
`137`	`142`
`138`	`143`	`export function wrappedRenderB(`

`‎types/tsconfig.json‎`

Lines changed: 1 addition & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"extends": "../node_modules/kcd-scripts/shared-tsconfig.json",`
`3`	`3`	`"compilerOptions": {`
	`4`	`+ "exactOptionalPropertyTypes": true,`
`4`	`5`	`"skipLibCheck": false`
`5`	`6`	`},`
`6`	`7`	`"include": ["."]`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 3dcd8a9

File tree

3 files changed

3 files changed

`‎types/index.d.ts‎`

`‎types/test.tsx‎`

`‎types/tsconfig.json‎`

0 commit comments