mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
77 lines
3.3 KiB
TypeScript
77 lines
3.3 KiB
TypeScript
// Type definitions for react-test-renderer 16.8
|
|
// Project: https://facebook.github.io/react/
|
|
// Definitions by: Arvitaly <https://github.com/arvitaly>
|
|
// Lochbrunner <https://github.com/lochbrunner>
|
|
// John Reilly <https://github.com/johnnyreilly>
|
|
// John Gozde <https://github.com/jgoz>
|
|
// Jessica Franco <https://github.com/Jessidhia>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 2.8
|
|
|
|
import { ReactElement, ReactType } from "react";
|
|
|
|
// extracted from:
|
|
// - https://github.com/facebook/react/blob/v16.0.0/src/renderers/testing/ReactTestRendererFiberEntry.js
|
|
// - https://reactjs.org/docs/test-renderer.html
|
|
|
|
export interface ReactTestRendererJSON {
|
|
type: string;
|
|
props: { [propName: string]: any };
|
|
children: null | ReactTestRendererJSON[];
|
|
}
|
|
export interface ReactTestRendererTree extends ReactTestRendererJSON {
|
|
nodeType: "component" | "host";
|
|
instance: any;
|
|
rendered: null | ReactTestRendererTree;
|
|
}
|
|
export interface ReactTestInstance {
|
|
instance: any;
|
|
type: ReactType;
|
|
props: { [propName: string]: any };
|
|
parent: null | ReactTestInstance;
|
|
children: Array<ReactTestInstance | string>;
|
|
|
|
find(predicate: (node: ReactTestInstance) => boolean): ReactTestInstance;
|
|
findByType(type: ReactType): ReactTestInstance;
|
|
findByProps(props: { [propName: string]: any }): ReactTestInstance;
|
|
|
|
findAll(predicate: (node: ReactTestInstance) => boolean, options?: { deep: boolean }): ReactTestInstance[];
|
|
findAllByType(type: ReactType, options?: { deep: boolean }): ReactTestInstance[];
|
|
findAllByProps(props: { [propName: string]: any }, options?: { deep: boolean }): ReactTestInstance[];
|
|
}
|
|
export interface ReactTestRenderer {
|
|
toJSON(): null | ReactTestRendererJSON;
|
|
toTree(): null | ReactTestRendererTree;
|
|
unmount(nextElement?: ReactElement): void;
|
|
update(nextElement: ReactElement): void;
|
|
getInstance(): null | ReactTestInstance;
|
|
root: ReactTestInstance;
|
|
}
|
|
export interface TestRendererOptions {
|
|
createNodeMock(element: ReactElement): any;
|
|
}
|
|
export function create(nextElement: ReactElement, options?: TestRendererOptions): ReactTestRenderer;
|
|
|
|
/**
|
|
* Wrap any code rendering and triggering updates to your components into `act()` calls.
|
|
*
|
|
* Ensures that the behavior in your tests matches what happens in the browser
|
|
* more closely by executing pending `useEffect`s before returning. This also
|
|
* reduces the amount of re-renders done.
|
|
*
|
|
* @param callback A synchronous, void callback that will execute as a single, complete React commit.
|
|
*
|
|
* @see https://reactjs.org/blog/2019/02/06/react-v16.8.0.html#testing-hooks
|
|
*/
|
|
// the "void | undefined" is here to forbid any sneaky "Promise" returns.
|
|
// the actual return value is always a "DebugPromiseLike",
|
|
// but having an "| {}" makes it harder to accidentally use.
|
|
export function act(callback: () => void | undefined): DebugPromiseLike | {};
|
|
|
|
// Intentionally doesn't extend PromiseLike<never>.
|
|
// Ideally this should be as hard to accidentally use as possible.
|
|
export interface DebugPromiseLike {
|
|
// the actual then() in here is 0-ary, but that doesn't count as a PromiseLike.
|
|
then(onfulfilled: (value: never) => never, onrejected: (reason: never) => never): never;
|
|
}
|