Skip to content

fix: correct TS typings for shallow.debug #584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Esemesek merged 1 commit into from
Nov 2, 2020
Merged

fix: correct TS typings for shallow.debug #584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions typings/__tests__/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@ const findAllBy: Promise<ReactTestInstance[]>[] = [
// debug API
const debugFn = tree.debug();
const debugFnWithMessage = tree.debug('my message');
const shallowDebug = tree.debug.shallow();
const shallowDebugWithMessage = tree.debug.shallow('my message');

// update API
tree.update(<View />);
Expand Down
12 changes: 10 additions & 2 deletions typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,10 @@ interface FindByAPI {
value: string | RegExp,
waitForOptions?: WaitForOptions
) => FindReturn;
findByTestId: (testID: string | RegExp, waitForOptions?: WaitForOptions) => FindReturn;
findByTestId: (
testID: string | RegExp,
waitForOptions?: WaitForOptions
) => FindReturn;
findAllByText: (
text: string | RegExp,
waitForOptions?: WaitForOptions
Expand Down Expand Up @@ -295,14 +298,19 @@ export interface RenderOptions {
createNodeMock?: (element: React.ReactElement<any>) => any;
}

type Debug = {
(message?: string);
shallow: (message?: string) => void;
};

type Queries = GetByAPI & QueryByAPI & FindByAPI & A11yAPI;

export interface RenderAPI extends Queries {
update(nextElement: React.ReactElement<any>): void;
rerender(nextElement: React.ReactElement<any>): void;
unmount(nextElement?: React.ReactElement<any>): void;
toJSON(): ReactTestRendererJSON | null;
debug(message?: string): void;
debug: Debug;
container: ReactTestInstance;
}

Expand Down