@types/react 18.3.12 → 18.3.14

react/README.md → react v18.3/README.md

@@ -5,10 +5,10 @@
 This package contains type definitions for react (https://react.dev/).
 
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react.
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react/v18.
 
 ### Additional Details
- * Last updated: Wed, 23 Oct 2024 03:36:41 GMT
+ * Last updated: Thu, 05 Dec 2024 19:32:25 GMT
  * Dependencies: [@types/prop-types](https://npmjs.com/package/@types/prop-types), [csstype](https://npmjs.com/package/csstype)
 
 # Credits

react/package.json → react v18.3/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/react",
-    "version": "18.3.12",
+    "version": "18.3.14",
     "description": "TypeScript definitions for react",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/react",
     "license": "MIT",
@@ -156,22 +156,6 @@
                 "default": "./index.d.ts"
             }
         },
-        "./canary": {
-            "types@<=5.0": {
-                "default": "./ts5.0/canary.d.ts"
-            },
-            "types": {
-                "default": "./canary.d.ts"
-            }
-        },
-        "./experimental": {
-            "types@<=5.0": {
-                "default": "./ts5.0/experimental.d.ts"
-            },
-            "types": {
-                "default": "./experimental.d.ts"
-            }
-        },
         "./jsx-runtime": {
             "types@<=5.0": {
                 "default": "./ts5.0/jsx-runtime.d.ts"
@@ -201,6 +185,6 @@
         "csstype": "^3.0.2"
     },
     "peerDependencies": {},
-    "typesPublisherContentHash": "d59942da5433cf6c9d66442070074fa48ef9c823a4175da6e4d183d0a70ccc72",
-    "typeScriptVersion": "4.8"
+    "typesPublisherContentHash": "99bad3e25e0b921fbfc7d8f1937c1ebd7b8ed84c76df4456953201652dc5ebac",
+    "typeScriptVersion": "5.0"
 }

react/canary.d.ts

@@ -1,166 +0,0 @@
-/**
- * These are types for things that are present in the React `canary` release channel.
- *
- * To load the types declared here in an actual project, there are three ways. The easiest one,
- * if your `tsconfig.json` already has a `"types"` array in the `"compilerOptions"` section,
- * is to add `"react/canary"` to the `"types"` array.
- *
- * Alternatively, a specific import syntax can to be used from a typescript file.
- * This module does not exist in reality, which is why the {} is important:
- *
- * ```ts
- * import {} from 'react/canary'
- * ```
- *
- * It is also possible to include it through a triple-slash reference:
- *
- * ```ts
- * /// <reference types="react/canary" />
- * ```
- *
- * Either the import or the reference only needs to appear once, anywhere in the project.
- */
-
-// See https://github.com/facebook/react/blob/main/packages/react/src/React.js to see how the exports are declared,
-
-import React = require(".");
-
-export {};
-
-declare const UNDEFINED_VOID_ONLY: unique symbol;
-type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };
-
-type NativeToggleEvent = ToggleEvent;
-
-declare module "." {
-    export type Usable<T> = PromiseLike<T> | Context<T>;
-
-    export function use<T>(usable: Usable<T>): T;
-
-    interface ServerContextJSONArray extends ReadonlyArray<ServerContextJSONValue> {}
-    export type ServerContextJSONValue =
-        | string
-        | boolean
-        | number
-        | null
-        | ServerContextJSONArray
-        | { [key: string]: ServerContextJSONValue };
-    export interface ServerContext<T extends ServerContextJSONValue> {
-        Provider: Provider<T>;
-    }
-    /**
-     * Accepts a context object (the value returned from `React.createContext` or `React.createServerContext`) and returns the current
-     * context value, as given by the nearest context provider for the given context.
-     *
-     * @version 16.8.0
-     * @see https://react.dev/reference/react/useContext
-     */
-    function useContext<T extends ServerContextJSONValue>(context: ServerContext<T>): T;
-    export function createServerContext<T extends ServerContextJSONValue>(
-        globalName: string,
-        defaultValue: T,
-    ): ServerContext<T>;
-
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-    export function cache<CachedFunction extends Function>(fn: CachedFunction): CachedFunction;
-
-    export function unstable_useCacheRefresh(): () => void;
-
-    interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS {
-        functions: (formData: FormData) => void | Promise<void>;
-    }
-
-    export interface TransitionStartFunction {
-        /**
-         * Marks all state updates inside the async function as transitions
-         *
-         * @see {https://react.dev/reference/react/useTransition#starttransition}
-         *
-         * @param callback
-         */
-        (callback: () => Promise<VoidOrUndefinedOnly>): void;
-    }
-
-    /**
-     * Similar to `useTransition` but allows uses where hooks are not available.
-     *
-     * @param callback An _asynchronous_ function which causes state updates that can be deferred.
-     */
-    export function startTransition(scope: () => Promise<VoidOrUndefinedOnly>): void;
-
-    export function useOptimistic<State>(
-        passthrough: State,
-    ): [State, (action: State | ((pendingState: State) => State)) => void];
-    export function useOptimistic<State, Action>(
-        passthrough: State,
-        reducer: (state: State, action: Action) => State,
-    ): [State, (action: Action) => void];
-
-    interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES {
-        cleanup: () => VoidOrUndefinedOnly;
-    }
-
-    export function useActionState<State>(
-        action: (state: Awaited<State>) => State | Promise<State>,
-        initialState: Awaited<State>,
-        permalink?: string,
-    ): [state: Awaited<State>, dispatch: () => void, isPending: boolean];
-    export function useActionState<State, Payload>(
-        action: (state: Awaited<State>, payload: Payload) => State | Promise<State>,
-        initialState: Awaited<State>,
-        permalink?: string,
-    ): [state: Awaited<State>, dispatch: (payload: Payload) => void, isPending: boolean];
-
-    interface DOMAttributes<T> {
-        // Transition Events
-        onTransitionCancel?: TransitionEventHandler<T> | undefined;
-        onTransitionCancelCapture?: TransitionEventHandler<T> | undefined;
-        onTransitionRun?: TransitionEventHandler<T> | undefined;
-        onTransitionRunCapture?: TransitionEventHandler<T> | undefined;
-        onTransitionStart?: TransitionEventHandler<T> | undefined;
-        onTransitionStartCapture?: TransitionEventHandler<T> | undefined;
-    }
-
-    type ToggleEventHandler<T = Element> = EventHandler<ToggleEvent<T>>;
-
-    interface HTMLAttributes<T> {
-        popover?: "" | "auto" | "manual" | undefined;
-        popoverTargetAction?: "toggle" | "show" | "hide" | undefined;
-        popoverTarget?: string | undefined;
-        onToggle?: ToggleEventHandler<T> | undefined;
-        onBeforeToggle?: ToggleEventHandler<T> | undefined;
-    }
-
-    interface ToggleEvent<T = Element> extends SyntheticEvent<T, NativeToggleEvent> {
-        oldState: "closed" | "open";
-        newState: "closed" | "open";
-    }
-
-    interface LinkHTMLAttributes<T> {
-        precedence?: string | undefined;
-    }
-
-    interface StyleHTMLAttributes<T> {
-        href?: string | undefined;
-        precedence?: string | undefined;
-    }
-
-    /**
-     * @internal Use `Awaited<ReactNode>` instead
-     */
-    // Helper type to enable `Awaited<ReactNode>`.
-    // Must be a copy of the non-thenables of `ReactNode`.
-    type AwaitedReactNode =
-        | ReactElement
-        | string
-        | number
-        | Iterable<AwaitedReactNode>
-        | ReactPortal
-        | boolean
-        | null
-        | undefined;
-    interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES {
-        promises: Promise<AwaitedReactNode>;
-        bigints: bigint;
-    }
-}

react/experimental.d.ts

@@ -1,127 +0,0 @@
-/**
- * These are types for things that are present in the `experimental` builds of React but not yet
- * on a stable build.
- *
- * Once they are promoted to stable they can just be moved to the main index file.
- *
- * To load the types declared here in an actual project, there are three ways. The easiest one,
- * if your `tsconfig.json` already has a `"types"` array in the `"compilerOptions"` section,
- * is to add `"react/experimental"` to the `"types"` array.
- *
- * Alternatively, a specific import syntax can to be used from a typescript file.
- * This module does not exist in reality, which is why the {} is important:
- *
- * ```ts
- * import {} from 'react/experimental'
- * ```
- *
- * It is also possible to include it through a triple-slash reference:
- *
- * ```ts
- * /// <reference types="react/experimental" />
- * ```
- *
- * Either the import or the reference only needs to appear once, anywhere in the project.
- */
-
-// See https://github.com/facebook/react/blob/master/packages/react/src/React.js to see how the exports are declared,
-// and https://github.com/facebook/react/blob/master/packages/shared/ReactFeatureFlags.js to verify which APIs are
-// flagged experimental or not. Experimental APIs will be tagged with `__EXPERIMENTAL__`.
-//
-// For the inputs of types exported as simply a fiber tag, the `beginWork` function of ReactFiberBeginWork.js
-// is a good place to start looking for details; it generally calls prop validation functions or delegates
-// all tasks done as part of the render phase (the concurrent part of the React update cycle).
-//
-// Suspense-related handling can be found in ReactFiberThrow.js.
-
-import React = require("./canary");
-
-export {};
-
-declare const UNDEFINED_VOID_ONLY: unique symbol;
-type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };
-
-declare module "." {
-    export interface SuspenseProps {
-        /**
-         * The presence of this prop indicates that the content is computationally expensive to render.
-         * In other words, the tree is CPU bound and not I/O bound (e.g. due to fetching data).
-         * @see {@link https://github.com/facebook/react/pull/19936}
-         */
-        unstable_expectedLoadTime?: number | undefined;
-    }
-
-    export type SuspenseListRevealOrder = "forwards" | "backwards" | "together";
-    export type SuspenseListTailMode = "collapsed" | "hidden";
-
-    export interface SuspenseListCommonProps {
-        /**
-         * Note that SuspenseList require more than one child;
-         * it is a runtime warning to provide only a single child.
-         *
-         * It does, however, allow those children to be wrapped inside a single
-         * level of `<React.Fragment>`.
-         */
-        children: ReactElement | Iterable<ReactElement>;
-    }
-
-    interface DirectionalSuspenseListProps extends SuspenseListCommonProps {
-        /**
-         * Defines the order in which the `SuspenseList` children should be revealed.
-         */
-        revealOrder: "forwards" | "backwards";
-        /**
-         * Dictates how unloaded items in a SuspenseList is shown.
-         *
-         * - By default, `SuspenseList` will show all fallbacks in the list.
-         * - `collapsed` shows only the next fallback in the list.
-         * - `hidden` doesn’t show any unloaded items.
-         */
-        tail?: SuspenseListTailMode | undefined;
-    }
-
-    interface NonDirectionalSuspenseListProps extends SuspenseListCommonProps {
-        /**
-         * Defines the order in which the `SuspenseList` children should be revealed.
-         */
-        revealOrder?: Exclude<SuspenseListRevealOrder, DirectionalSuspenseListProps["revealOrder"]> | undefined;
-        /**
-         * The tail property is invalid when not using the `forwards` or `backwards` reveal orders.
-         */
-        tail?: never | undefined;
-    }
-
-    export type SuspenseListProps = DirectionalSuspenseListProps | NonDirectionalSuspenseListProps;
-
-    /**
-     * `SuspenseList` helps coordinate many components that can suspend by orchestrating the order
-     * in which these components are revealed to the user.
-     *
-     * When multiple components need to fetch data, this data may arrive in an unpredictable order.
-     * However, if you wrap these items in a `SuspenseList`, React will not show an item in the list
-     * until previous items have been displayed (this behavior is adjustable).
-     *
-     * @see https://reactjs.org/docs/concurrent-mode-reference.html#suspenselist
-     * @see https://reactjs.org/docs/concurrent-mode-patterns.html#suspenselist
-     */
-    export const unstable_SuspenseList: ExoticComponent<SuspenseListProps>;
-
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-    export function experimental_useEffectEvent<T extends Function>(event: T): T;
-
-    type Reference = object;
-    type TaintableUniqueValue = string | bigint | ArrayBufferView;
-    function experimental_taintUniqueValue(
-        message: string | undefined,
-        lifetime: Reference,
-        value: TaintableUniqueValue,
-    ): void;
-    function experimental_taintObjectReference(message: string | undefined, object: Reference): void;
-
-    export interface HTMLAttributes<T> {
-        /**
-         * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
-         */
-        inert?: boolean | undefined;
-    }
-}

react/ts5.0/canary.d.ts

@@ -1,166 +0,0 @@
-/**
- * These are types for things that are present in the React `canary` release channel.
- *
- * To load the types declared here in an actual project, there are three ways. The easiest one,
- * if your `tsconfig.json` already has a `"types"` array in the `"compilerOptions"` section,
- * is to add `"react/canary"` to the `"types"` array.
- *
- * Alternatively, a specific import syntax can to be used from a typescript file.
- * This module does not exist in reality, which is why the {} is important:
- *
- * ```ts
- * import {} from 'react/canary'
- * ```
- *
- * It is also possible to include it through a triple-slash reference:
- *
- * ```ts
- * /// <reference types="react/canary" />
- * ```
- *
- * Either the import or the reference only needs to appear once, anywhere in the project.
- */
-
-// See https://github.com/facebook/react/blob/main/packages/react/src/React.js to see how the exports are declared,
-
-import React = require(".");
-
-export {};
-
-declare const UNDEFINED_VOID_ONLY: unique symbol;
-type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };
-
-type NativeToggleEvent = ToggleEvent;
-
-declare module "." {
-    export type Usable<T> = PromiseLike<T> | Context<T>;
-
-    export function use<T>(usable: Usable<T>): T;
-
-    interface ServerContextJSONArray extends ReadonlyArray<ServerContextJSONValue> {}
-    export type ServerContextJSONValue =
-        | string
-        | boolean
-        | number
-        | null
-        | ServerContextJSONArray
-        | { [key: string]: ServerContextJSONValue };
-    export interface ServerContext<T extends ServerContextJSONValue> {
-        Provider: Provider<T>;
-    }
-    /**
-     * Accepts a context object (the value returned from `React.createContext` or `React.createServerContext`) and returns the current
-     * context value, as given by the nearest context provider for the given context.
-     *
-     * @version 16.8.0
-     * @see https://react.dev/reference/react/useContext
-     */
-    function useContext<T extends ServerContextJSONValue>(context: ServerContext<T>): T;
-    export function createServerContext<T extends ServerContextJSONValue>(
-        globalName: string,
-        defaultValue: T,
-    ): ServerContext<T>;
-
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-    export function cache<CachedFunction extends Function>(fn: CachedFunction): CachedFunction;
-
-    export function unstable_useCacheRefresh(): () => void;
-
-    interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_FORM_ACTIONS {
-        functions: (formData: FormData) => void | Promise<void>;
-    }
-
-    export interface TransitionStartFunction {
-        /**
-         * Marks all state updates inside the async function as transitions
-         *
-         * @see {https://react.dev/reference/react/useTransition#starttransition}
-         *
-         * @param callback
-         */
-        (callback: () => Promise<VoidOrUndefinedOnly>): void;
-    }
-
-    /**
-     * Similar to `useTransition` but allows uses where hooks are not available.
-     *
-     * @param callback An _asynchronous_ function which causes state updates that can be deferred.
-     */
-    export function startTransition(scope: () => Promise<VoidOrUndefinedOnly>): void;
-
-    export function useOptimistic<State>(
-        passthrough: State,
-    ): [State, (action: State | ((pendingState: State) => State)) => void];
-    export function useOptimistic<State, Action>(
-        passthrough: State,
-        reducer: (state: State, action: Action) => State,
-    ): [State, (action: Action) => void];
-
-    interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_CALLBACK_REF_RETURN_VALUES {
-        cleanup: () => VoidOrUndefinedOnly;
-    }
-
-    export function useActionState<State>(
-        action: (state: Awaited<State>) => State | Promise<State>,
-        initialState: Awaited<State>,
-        permalink?: string,
-    ): [state: Awaited<State>, dispatch: () => void, isPending: boolean];
-    export function useActionState<State, Payload>(
-        action: (state: Awaited<State>, payload: Payload) => State | Promise<State>,
-        initialState: Awaited<State>,
-        permalink?: string,
-    ): [state: Awaited<State>, dispatch: (payload: Payload) => void, isPending: boolean];
-
-    interface DOMAttributes<T> {
-        // Transition Events
-        onTransitionCancel?: TransitionEventHandler<T> | undefined;
-        onTransitionCancelCapture?: TransitionEventHandler<T> | undefined;
-        onTransitionRun?: TransitionEventHandler<T> | undefined;
-        onTransitionRunCapture?: TransitionEventHandler<T> | undefined;
-        onTransitionStart?: TransitionEventHandler<T> | undefined;
-        onTransitionStartCapture?: TransitionEventHandler<T> | undefined;
-    }
-
-    type ToggleEventHandler<T = Element> = EventHandler<ToggleEvent<T>>;
-
-    interface HTMLAttributes<T> {
-        popover?: "" | "auto" | "manual" | undefined;
-        popoverTargetAction?: "toggle" | "show" | "hide" | undefined;
-        popoverTarget?: string | undefined;
-        onToggle?: ToggleEventHandler<T> | undefined;
-        onBeforeToggle?: ToggleEventHandler<T> | undefined;
-    }
-
-    interface ToggleEvent<T = Element> extends SyntheticEvent<T, NativeToggleEvent> {
-        oldState: "closed" | "open";
-        newState: "closed" | "open";
-    }
-
-    interface LinkHTMLAttributes<T> {
-        precedence?: string | undefined;
-    }
-
-    interface StyleHTMLAttributes<T> {
-        href?: string | undefined;
-        precedence?: string | undefined;
-    }
-
-    /**
-     * @internal Use `Awaited<ReactNode>` instead
-     */
-    // Helper type to enable `Awaited<ReactNode>`.
-    // Must be a copy of the non-thenables of `ReactNode`.
-    type AwaitedReactNode =
-        | ReactElement
-        | string
-        | number
-        | Iterable<AwaitedReactNode>
-        | ReactPortal
-        | boolean
-        | null
-        | undefined;
-    interface DO_NOT_USE_OR_YOU_WILL_BE_FIRED_EXPERIMENTAL_REACT_NODES {
-        promises: Promise<AwaitedReactNode>;
-        bigints: bigint;
-    }
-}

react/ts5.0/experimental.d.ts

@@ -1,127 +0,0 @@
-/**
- * These are types for things that are present in the `experimental` builds of React but not yet
- * on a stable build.
- *
- * Once they are promoted to stable they can just be moved to the main index file.
- *
- * To load the types declared here in an actual project, there are three ways. The easiest one,
- * if your `tsconfig.json` already has a `"types"` array in the `"compilerOptions"` section,
- * is to add `"react/experimental"` to the `"types"` array.
- *
- * Alternatively, a specific import syntax can to be used from a typescript file.
- * This module does not exist in reality, which is why the {} is important:
- *
- * ```ts
- * import {} from 'react/experimental'
- * ```
- *
- * It is also possible to include it through a triple-slash reference:
- *
- * ```ts
- * /// <reference types="react/experimental" />
- * ```
- *
- * Either the import or the reference only needs to appear once, anywhere in the project.
- */
-
-// See https://github.com/facebook/react/blob/master/packages/react/src/React.js to see how the exports are declared,
-// and https://github.com/facebook/react/blob/master/packages/shared/ReactFeatureFlags.js to verify which APIs are
-// flagged experimental or not. Experimental APIs will be tagged with `__EXPERIMENTAL__`.
-//
-// For the inputs of types exported as simply a fiber tag, the `beginWork` function of ReactFiberBeginWork.js
-// is a good place to start looking for details; it generally calls prop validation functions or delegates
-// all tasks done as part of the render phase (the concurrent part of the React update cycle).
-//
-// Suspense-related handling can be found in ReactFiberThrow.js.
-
-import React = require("./canary");
-
-export {};
-
-declare const UNDEFINED_VOID_ONLY: unique symbol;
-type VoidOrUndefinedOnly = void | { [UNDEFINED_VOID_ONLY]: never };
-
-declare module "." {
-    export interface SuspenseProps {
-        /**
-         * The presence of this prop indicates that the content is computationally expensive to render.
-         * In other words, the tree is CPU bound and not I/O bound (e.g. due to fetching data).
-         * @see {@link https://github.com/facebook/react/pull/19936}
-         */
-        unstable_expectedLoadTime?: number | undefined;
-    }
-
-    export type SuspenseListRevealOrder = "forwards" | "backwards" | "together";
-    export type SuspenseListTailMode = "collapsed" | "hidden";
-
-    export interface SuspenseListCommonProps {
-        /**
-         * Note that SuspenseList require more than one child;
-         * it is a runtime warning to provide only a single child.
-         *
-         * It does, however, allow those children to be wrapped inside a single
-         * level of `<React.Fragment>`.
-         */
-        children: ReactElement | Iterable<ReactElement>;
-    }
-
-    interface DirectionalSuspenseListProps extends SuspenseListCommonProps {
-        /**
-         * Defines the order in which the `SuspenseList` children should be revealed.
-         */
-        revealOrder: "forwards" | "backwards";
-        /**
-         * Dictates how unloaded items in a SuspenseList is shown.
-         *
-         * - By default, `SuspenseList` will show all fallbacks in the list.
-         * - `collapsed` shows only the next fallback in the list.
-         * - `hidden` doesn’t show any unloaded items.
-         */
-        tail?: SuspenseListTailMode | undefined;
-    }
-
-    interface NonDirectionalSuspenseListProps extends SuspenseListCommonProps {
-        /**
-         * Defines the order in which the `SuspenseList` children should be revealed.
-         */
-        revealOrder?: Exclude<SuspenseListRevealOrder, DirectionalSuspenseListProps["revealOrder"]> | undefined;
-        /**
-         * The tail property is invalid when not using the `forwards` or `backwards` reveal orders.
-         */
-        tail?: never | undefined;
-    }
-
-    export type SuspenseListProps = DirectionalSuspenseListProps | NonDirectionalSuspenseListProps;
-
-    /**
-     * `SuspenseList` helps coordinate many components that can suspend by orchestrating the order
-     * in which these components are revealed to the user.
-     *
-     * When multiple components need to fetch data, this data may arrive in an unpredictable order.
-     * However, if you wrap these items in a `SuspenseList`, React will not show an item in the list
-     * until previous items have been displayed (this behavior is adjustable).
-     *
-     * @see https://reactjs.org/docs/concurrent-mode-reference.html#suspenselist
-     * @see https://reactjs.org/docs/concurrent-mode-patterns.html#suspenselist
-     */
-    export const unstable_SuspenseList: ExoticComponent<SuspenseListProps>;
-
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
-    export function experimental_useEffectEvent<T extends Function>(event: T): T;
-
-    type Reference = object;
-    type TaintableUniqueValue = string | bigint | ArrayBufferView;
-    function experimental_taintUniqueValue(
-        message: string | undefined,
-        lifetime: Reference,
-        value: TaintableUniqueValue,
-    ): void;
-    function experimental_taintObjectReference(message: string | undefined, object: Reference): void;
-
-    export interface HTMLAttributes<T> {
-        /**
-         * @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/inert
-         */
-        inert?: boolean | undefined;
-    }
-}