@types/react-dom 18.2.6 → 18.2.8

react-dom/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for React (react-dom) (https://reactjs.or
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-dom.
 
 ### Additional Details
- * Last updated: Mon, 19 Jun 2023 12:32:43 GMT
+ * Last updated: Wed, 27 Sep 2023 07:12:04 GMT
  * Dependencies: [@types/react](https://npmjs.com/package/@types/react)
  * Global values: `ReactDOM`, `ReactDOMServer`
 

react-dom/canary.d.ts

@@ -26,13 +26,13 @@
 // See https://github.com/facebook/react/blob/main/packages/react-dom/index.js to see how the exports are declared,
 // but confirm with published source code (e.g. https://unpkg.com/react-dom@canary) that these exports end up in the published code
 
-import React = require('react');
-import ReactDOM = require('.');
+import React = require("react");
+import ReactDOM = require(".");
 
 export {};
 
-declare module '.' {
-    type PreloadAs = 'font' | 'script' | 'style';
+declare module "." {
+    type PreloadAs = "font" | "script" | "style";
     interface PreloadOptions {
         as: PreloadAs;
         crossOrigin?: string | undefined;
@@ -40,7 +40,7 @@ declare module '.' {
     }
     function preload(href: string, options?: PreloadOptions): void;
 
-    type PreinitAs = 'script' | 'style';
+    type PreinitAs = "script" | "style";
     interface PreinitOptions {
         as: PreinitAs;
         crossOrigin?: string | undefined;

react-dom/client.d.ts

@@ -4,7 +4,7 @@
 
 // See https://github.com/facebook/react/blob/main/packages/react-dom/client.js to see how the exports are declared,
 
-import React = require('react');
+import React = require("react");
 export interface HydrationOptions {
     /**
      * Prefix for `useId`.

react-dom/experimental.d.ts

@@ -27,12 +27,12 @@
 // See https://github.com/facebook/react/blob/main/packages/react-dom/index.experimental.js to see how the exports are declared,
 // but confirm with published source code (e.g. https://unpkg.com/react-dom@experimental) that these exports end up in the published code
 
-import React = require('react');
-import ReactDOM = require('./canary');
+import React = require("react");
+import ReactDOM = require("./canary");
 
 export {};
 
-declare module '.' {
+declare module "." {
     interface FormStatusNotPending {
         pending: false;
         data: null;

react-dom/index.d.ts

@@ -17,15 +17,26 @@
 export as namespace ReactDOM;
 
 import {
-    ReactInstance, Component, ComponentState,
-    ReactElement, FunctionComponentElement, CElement,
-    DOMAttributes, DOMElement, ReactNode, ReactPortal
-} from 'react';
+    CElement,
+    Component,
+    ComponentState,
+    DOMAttributes,
+    DOMElement,
+    FunctionComponentElement,
+    ReactElement,
+    ReactInstance,
+    ReactNode,
+    ReactPortal,
+} from "react";
 
 export function findDOMNode(instance: ReactInstance | null | undefined): Element | null | Text;
 export function unmountComponentAtNode(container: Element | DocumentFragment): boolean;
 
-export function createPortal(children: ReactNode, container: Element | DocumentFragment, key?: null | string): ReactPortal;
+export function createPortal(
+    children: ReactNode,
+    container: Element | DocumentFragment,
+    key?: null | string,
+): ReactPortal;
 
 export const version: string;
 export const render: Renderer;
@@ -41,17 +52,20 @@ export function unstable_renderSubtreeIntoContainer<T extends Element>(
     parentComponent: Component<any>,
     element: DOMElement<DOMAttributes<T>, T>,
     container: Element,
-    callback?: (element: T) => any): T;
+    callback?: (element: T) => any,
+): T;
 export function unstable_renderSubtreeIntoContainer<P, T extends Component<P, ComponentState>>(
     parentComponent: Component<any>,
     element: CElement<P, T>,
     container: Element,
-    callback?: (component: T) => any): T;
+    callback?: (component: T) => any,
+): T;
 export function unstable_renderSubtreeIntoContainer<P>(
     parentComponent: Component<any>,
     element: ReactElement<P>,
     container: Element,
-    callback?: (component?: Component<P, ComponentState> | Element) => any): Component<P, ComponentState> | Element | void;
+    callback?: (component?: Component<P, ComponentState> | Element) => any,
+): Component<P, ComponentState> | Element | void;
 
 export type Container = Element | Document | DocumentFragment;
 
@@ -61,43 +75,43 @@ export interface Renderer {
 
     <T extends Element>(
         element: DOMElement<DOMAttributes<T>, T>,
-        container: Container| null,
-        callback?: () => void
+        container: Container | null,
+        callback?: () => void,
     ): T;
 
     (
         element: Array<DOMElement<DOMAttributes<any>, any>>,
-        container: Container| null,
-        callback?: () => void
+        container: Container | null,
+        callback?: () => void,
     ): Element;
 
     (
         element: FunctionComponentElement<any> | Array<FunctionComponentElement<any>>,
-        container: Container| null,
-        callback?: () => void
+        container: Container | null,
+        callback?: () => void,
     ): void;
 
     <P, T extends Component<P, ComponentState>>(
         element: CElement<P, T>,
-        container: Container| null,
-        callback?: () => void
+        container: Container | null,
+        callback?: () => void,
     ): T;
 
     (
         element: Array<CElement<any, Component<any, ComponentState>>>,
-        container: Container| null,
-        callback?: () => void
+        container: Container | null,
+        callback?: () => void,
     ): Component<any, ComponentState>;
 
     <P>(
         element: ReactElement<P>,
-        container: Container| null,
-        callback?: () => void
+        container: Container | null,
+        callback?: () => void,
     ): Component<P, ComponentState> | Element | void;
 
     (
         element: ReactElement[],
-        container: Container| null,
-        callback?: () => void
+        container: Container | null,
+        callback?: () => void,
     ): Component<any, ComponentState> | Element | void;
 }

react-dom/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/react-dom",
-    "version": "18.2.6",
+    "version": "18.2.8",
     "description": "TypeScript definitions for React (react-dom)",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react-dom",
     "license": "MIT",
@@ -49,8 +49,8 @@
     "dependencies": {
         "@types/react": "*"
     },
-    "typesPublisherContentHash": "f17619716ec62b2f4f9d4541bc4e5fe0365b64cd6abc76511a375496bf09747a",
-    "typeScriptVersion": "4.3",
+    "typesPublisherContentHash": "f37f361aad53e3f7a39972574a1b1cab2abe083c8bf24b0529d11877c5e0f940",
+    "typeScriptVersion": "4.5",
     "exports": {
         ".": {
             "types": {

react-dom/server.d.ts

@@ -21,8 +21,8 @@ declare global {
     interface ReadableStream {}
 }
 
-import { ReactElement, ReactNode } from 'react';
-import { ErrorInfo } from './client';
+import { ReactElement, ReactNode } from "react";
+import { ErrorInfo } from "./client";
 
 export interface RenderToPipeableStreamOptions {
     identifierPrefix?: string;
@@ -39,7 +39,7 @@ export interface RenderToPipeableStreamOptions {
 }
 
 export interface PipeableStream {
-    abort: () => void;
+    abort: (reason?: unknown) => void;
     pipe: <Writable extends NodeJS.WritableStream>(destination: Writable) => Writable;
 }
 

react-dom/test-utils/index.d.ts

@@ -1,9 +1,17 @@
 import {
-    AbstractView, Component, ComponentClass,
-    ReactElement, ReactInstance, ClassType,
-    DOMElement, FunctionComponentElement, CElement,
-    ReactHTMLElement, DOMAttributes, FC
-} from 'react';
+    AbstractView,
+    CElement,
+    ClassType,
+    Component,
+    ComponentClass,
+    DOMAttributes,
+    DOMElement,
+    FC,
+    FunctionComponentElement,
+    ReactElement,
+    ReactHTMLElement,
+    ReactInstance,
+} from "react";
 
 import * as ReactTestUtils from ".";
 
@@ -24,7 +32,21 @@ export interface OptionalEventProperties {
     type?: string | undefined;
 }
 
-export type ModifierKey = "Alt" | "AltGraph" | "CapsLock" | "Control" | "Fn" | "FnLock" | "Hyper" | "Meta" | "NumLock" | "ScrollLock" | "Shift" | "Super" | "Symbol" | "SymbolLock";
+export type ModifierKey =
+    | "Alt"
+    | "AltGraph"
+    | "CapsLock"
+    | "Control"
+    | "Fn"
+    | "FnLock"
+    | "Hyper"
+    | "Meta"
+    | "NumLock"
+    | "ScrollLock"
+    | "Shift"
+    | "Super"
+    | "Symbol"
+    | "SymbolLock";
 
 export interface SyntheticEventData extends OptionalEventProperties {
     altKey?: boolean | undefined;
@@ -63,7 +85,7 @@ export interface SyntheticEventData extends OptionalEventProperties {
 export type EventSimulator = (element: Element | Component<any>, eventData?: SyntheticEventData) => void;
 
 export interface MockedComponentClass {
-    new (props: any): any;
+    new(props: any): any;
 }
 
 export interface ShallowRenderer {
@@ -82,7 +104,7 @@ export interface ShallowRenderer {
  * Simulate an event dispatch on a DOM node with optional `eventData` event data.
  * `Simulate` has a method for every event that React understands.
  */
- export namespace Simulate {
+export namespace Simulate {
     const abort: EventSimulator;
     const animationEnd: EventSimulator;
     const animationIteration: EventSimulator;
@@ -174,17 +196,21 @@ export interface ShallowRenderer {
  * Render a React element into a detached DOM node in the document. __This function requires a DOM__.
  */
 export function renderIntoDocument<T extends Element>(
-    element: DOMElement<any, T>): T;
+    element: DOMElement<any, T>,
+): T;
 export function renderIntoDocument(
-    element: FunctionComponentElement<any>): void;
+    element: FunctionComponentElement<any>,
+): void;
 // If we replace `P` with `any` in this overload, then some tests fail because
 // calls to `renderIntoDocument` choose the last overload on the
 // subtype-relation pass and get an undesirably broad return type.  Using `P`
 // allows this overload to match on the subtype-relation pass.
 export function renderIntoDocument<P, T extends Component<P>>(
-    element: CElement<P, T>): T;
+    element: CElement<P, T>,
+): T;
 export function renderIntoDocument<P>(
-    element: ReactElement<P>): Component<P> | Element | void;
+    element: ReactElement<P>,
+): Component<P> | Element | void;
 
 /**
  * Pass a mocked component module to this method to augment it with useful methods that allow it to
@@ -192,7 +218,9 @@ export function renderIntoDocument<P>(
  * a simple `<div>` (or other tag if `mockTagName` is provided) containing any provided children.
  */
 export function mockComponent(
-    mocked: MockedComponentClass, mockTagName?: string): typeof ReactTestUtils;
+    mocked: MockedComponentClass,
+    mockTagName?: string,
+): typeof ReactTestUtils;
 
 /**
  * Returns `true` if `element` is any React element.
@@ -203,22 +231,30 @@ export function isElement(element: any): boolean;
  * Returns `true` if `element` is a React element whose type is of a React `componentClass`.
  */
 export function isElementOfType<T extends HTMLElement>(
-    element: ReactElement, type: string): element is ReactHTMLElement<T>;
+    element: ReactElement,
+    type: string,
+): element is ReactHTMLElement<T>;
 /**
  * Returns `true` if `element` is a React element whose type is of a React `componentClass`.
  */
 export function isElementOfType<P extends DOMAttributes<{}>, T extends Element>(
-    element: ReactElement, type: string): element is DOMElement<P, T>;
+    element: ReactElement,
+    type: string,
+): element is DOMElement<P, T>;
 /**
  * Returns `true` if `element` is a React element whose type is of a React `componentClass`.
  */
 export function isElementOfType<P>(
-    element: ReactElement, type: FC<P>): element is FunctionComponentElement<P>;
+    element: ReactElement,
+    type: FC<P>,
+): element is FunctionComponentElement<P>;
 /**
  * Returns `true` if `element` is a React element whose type is of a React `componentClass`.
  */
 export function isElementOfType<P, T extends Component<P>, C extends ComponentClass<P>>(
-    element: ReactElement, type: ClassType<P, T, C>): element is CElement<P, T>;
+    element: ReactElement,
+    type: ClassType<P, T, C>,
+): element is CElement<P, T>;
 
 /**
  * Returns `true` if `instance` is a DOM component (such as a `<div>` or `<span>`).
@@ -232,7 +268,9 @@ export function isCompositeComponent(instance: ReactInstance): instance is Compo
  * Returns `true` if `instance` is a component whose type is of a React `componentClass`.
  */
 export function isCompositeComponentWithType<T extends Component<any>, C extends ComponentClass<any>>(
-    instance: ReactInstance, type: ClassType<any, T, C>): boolean;
+    instance: ReactInstance,
+    type: ClassType<any, T, C>,
+): boolean;
 
 /**
  * Traverse all components in `tree` and accumulate all components where
@@ -241,7 +279,8 @@ export function isCompositeComponentWithType<T extends Component<any>, C extends
  */
 export function findAllInRenderedTree(
     root: Component<any>,
-    fn: (i: ReactInstance) => boolean): ReactInstance[];
+    fn: (i: ReactInstance) => boolean,
+): ReactInstance[];
 
 /**
  * Finds all DOM elements of components in the rendered tree that are
@@ -249,7 +288,8 @@ export function findAllInRenderedTree(
  */
 export function scryRenderedDOMComponentsWithClass(
     root: Component<any>,
-    className: string): Element[];
+    className: string,
+): Element[];
 /**
  * Like `scryRenderedDOMComponentsWithClass()` but expects there to be one result,
  * and returns that one result, or throws exception if there is any other
@@ -257,7 +297,8 @@ export function scryRenderedDOMComponentsWithClass(
  */
 export function findRenderedDOMComponentWithClass(
     root: Component<any>,
-    className: string): Element;
+    className: string,
+): Element;
 
 /**
  * Finds all DOM elements of components in the rendered tree that are
@@ -265,7 +306,8 @@ export function findRenderedDOMComponentWithClass(
  */
 export function scryRenderedDOMComponentsWithTag(
     root: Component<any>,
-    tagName: string): Element[];
+    tagName: string,
+): Element[];
 /**
  * Like `scryRenderedDOMComponentsWithTag()` but expects there to be one result,
  * and returns that one result, or throws exception if there is any other
@@ -273,14 +315,16 @@ export function scryRenderedDOMComponentsWithTag(
  */
 export function findRenderedDOMComponentWithTag(
     root: Component<any>,
-    tagName: string): Element;
+    tagName: string,
+): Element;
 
 /**
  * Finds all instances of components with type equal to `componentClass`.
  */
 export function scryRenderedComponentsWithType<T extends Component<any>, C extends ComponentClass<any>>(
     root: Component<any>,
-    type: ClassType<any, T, C>): T[];
+    type: ClassType<any, T, C>,
+): T[];
 
 /**
  * Same as `scryRenderedComponentsWithType()` but expects there to be one result
@@ -289,7 +333,8 @@ export function scryRenderedComponentsWithType<T extends Component<any>, C exten
  */
 export function findRenderedComponentWithType<T extends Component<any>, C extends ComponentClass<any>>(
     root: Component<any>,
-    type: ClassType<any, T, C>): T;
+    type: ClassType<any, T, C>,
+): T;
 
 /**
  * Call this in your tests to create a shallow renderer.