UNPKG

1.7 kBTypeScriptView Raw
1/**
2 * These are types for things that are present in the `experimental` builds of React but not yet
3 * on a stable build.
4 *
5 * Once they are promoted to stable they can just be moved to the main index file.
6 *
7 * To load the types declared here in an actual project, there are three ways. The easiest one,
8 * if your `tsconfig.json` already has a `"types"` array in the `"compilerOptions"` section,
9 * is to add `"react-dom/experimental"` to the `"types"` array.
10 *
11 * Alternatively, a specific import syntax can to be used from a typescript file.
12 * This module does not exist in reality, which is why the {} is important:
13 *
14 * ```ts
15 * import {} from 'react-dom/experimental'
16 * ```
17 *
18 * It is also possible to include it through a triple-slash reference:
19 *
20 * ```ts
21 * /// <reference types="react-dom/experimental" />
22 * ```
23 *
24 * Either the import or the reference only needs to appear once, anywhere in the project.
25 */
26
27// See https://github.com/facebook/react/blob/master/packages/react-dom/src/client/ReactDOM.js to see how the exports are declared,
28// and https://github.com/facebook/react/blob/master/packages/shared/ReactFeatureFlags.js to verify which APIs are
29// flagged experimental or not. Experimental APIs will be tagged with `__EXPERIMENTAL__`.
30
31import React = require('react');
32import ReactDOM = require('./next');
33
34export {};
35
36declare module '.' {
37 function unstable_flushControlled(callback: () => void): void;
38
39 // enableSelectiveHydration feature
40
41 /**
42 * @see https://github.com/facebook/react/commit/3a2b5f148d450c69aab67f055fc441d294c23518
43 */
44 function unstable_scheduleHydration(target: Element | Document | DocumentFragment | Comment): void;
45}