Skip to content

clean up code from index.d.ts #131

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
merged 5 commits into from
Jul 3, 2018
Merged

clean up code from index.d.ts #131

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c4be6fe
clean up code from index.d.ts
jpavon Jul 3, 2018
15301dd
remove wait and waitForElement
jpavon Jul 3, 2018
2742a25
remove non used import
jpavon Jul 3, 2018
67b44bb
use consistent void return
jpavon Jul 3, 2018
0fcfea5
unmount returns boolean
jpavon Jul 3, 2018
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
188 changes: 4 additions & 184 deletions typings/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,88 +1,14 @@
import {Simulate as ReactSimulate} from 'react-dom/test-utils'
import {
AllByAttribute,
AllByText,
BoundFunction,
GetByAttribute,
GetByText,
QueryByAttribute,
QueryByText,
} from 'dom-testing-library'
export {prettyDOM} from 'dom-testing-library'
import {getQueriesForElement} from 'dom-testing-library'

type TextMatchFunction = (content: string, element: HTMLElement) => boolean
type TextMatch = string | RegExp | TextMatchFunction
type TextMatchOptions = {
exact?: boolean
trim?: boolean
collapseWhitespace?: boolean
}

interface GetsAndQueries {
queryByPlaceholderText: BoundFunction<QueryByAttribute>
queryAllByPlaceholderText: BoundFunction<AllByAttribute>
getByPlaceholderText: BoundFunction<GetByAttribute>
getAllByPlaceholderText: BoundFunction<AllByAttribute>
queryByText: BoundFunction<QueryByText>
queryAllByText: BoundFunction<AllByText>
getByText: BoundFunction<GetByText>
getAllByText: BoundFunction<AllByText>
queryByLabelText: BoundFunction<QueryByText>
queryAllByLabelText: BoundFunction<AllByText>
getByLabelText: BoundFunction<GetByText>
getAllByLabelText: BoundFunction<AllByText>
queryByAltText: BoundFunction<QueryByAttribute>
queryAllByAltText: BoundFunction<AllByAttribute>
getByAltText: BoundFunction<GetByAttribute>
getAllByAltText: BoundFunction<AllByAttribute>
queryByTestId: BoundFunction<QueryByAttribute>
queryAllByTestId: BoundFunction<AllByAttribute>
getByTestId: BoundFunction<GetByAttribute>
getAllByTestId: BoundFunction<AllByAttribute>
queryByTitle: BoundFunction<QueryByAttribute>
queryAllByTitle: BoundFunction<AllByAttribute>
getByTitle: BoundFunction<GetByAttribute>
getAllByTitle: BoundFunction<AllByAttribute>
queryByValue: BoundFunction<QueryByAttribute>
queryAllByValue: BoundFunction<AllByAttribute>
getByValue: BoundFunction<GetByAttribute>
getAllByValue: BoundFunction<AllByAttribute>
}
export * from 'dom-testing-library'

export const queryByPlaceholderText: QueryByAttribute
export const queryAllByPlaceholderText: AllByAttribute
export const getByPlaceholderText: GetByAttribute
export const getAllByPlaceholderText: AllByAttribute
export const queryByText: QueryByText
export const queryAllByText: AllByText
export const getByText: GetByText
export const getAllByText: AllByText
export const queryByLabelText: QueryByText
export const queryAllByLabelText: AllByText
export const getByLabelText: GetByText
export const getAllByLabelText: AllByText
export const queryByAltText: QueryByAttribute
export const queryAllByAltText: AllByAttribute
export const getByAltText: GetByAttribute
export const getAllByAltText: AllByAttribute
export const queryByTestId: QueryByAttribute
export const queryAllByTestId: AllByAttribute
export const getByTestId: GetByAttribute
export const getAllByTestId: AllByAttribute
export const queryByTitle: QueryByAttribute
export const queryAllByTitle: AllByAttribute
export const getByTitle: GetByAttribute
export const getAllByTitle: AllByAttribute
export const queryByValue: QueryByAttribute
export const queryAllByValue: AllByAttribute
export const getByValue: GetByAttribute
export const getAllByValue: AllByAttribute
type GetsAndQueries = ReturnType<typeof getQueriesForElement>

export interface RenderResult extends GetsAndQueries {
container: HTMLDivElement
debug: () => void
rerender: (ui: React.ReactElement<any>) => void
unmount: VoidFunction
unmount: () => boolean
}

/**
Expand All @@ -93,113 +19,7 @@ export function render(
options?: {container: HTMLElement; baseElement: HTMLElement},
): RenderResult

/**
* When in need to wait for DOM elements to appear, disappear, or change. Prefer waitForElement.
*/
export function wait(
callback?: () => void,
options?: {
timeout?: number
interval?: number
},
): Promise<void>

/**
* When in need to wait for DOM elements to appear, disappear, or change.
*/
export function waitForElement<T>(
callback?: () => T,
options?: {
container?: HTMLElement
timeout?: number
mutationObserverOptions?: MutationObserverInit
},
): Promise<T | undefined>

type EventType =
| 'copy'
| 'cut'
| 'paste'
| 'compositionEnd'
| 'compositionStart'
| 'compositionUpdate'
| 'keyDown'
| 'keyPress'
| 'keyUp'
| 'focus'
| 'blur'
| 'change'
| 'input'
| 'invalid'
| 'submit'
| 'click'
| 'contextMenu'
| 'dblClick'
| 'drag'
| 'dragEnd'
| 'dragEnter'
| 'dragExit'
| 'dragLeave'
| 'dragOver'
| 'dragStart'
| 'drop'
| 'mouseDown'
| 'mouseEnter'
| 'mouseLeave'
| 'mouseMove'
| 'mouseOut'
| 'mouseOver'
| 'mouseUp'
| 'select'
| 'touchCancel'
| 'touchEnd'
| 'touchMove'
| 'touchStart'
| 'scroll'
| 'wheel'
| 'abort'
| 'canPlay'
| 'canPlayThrough'
| 'durationChange'
| 'emptied'
| 'encrypted'
| 'ended'
| 'loadedData'
| 'loadedMetadata'
| 'loadStart'
| 'pause'
| 'play'
| 'playing'
| 'progress'
| 'rateChange'
| 'seeked'
| 'seeking'
| 'stalled'
| 'suspend'
| 'timeUpdate'
| 'volumeChange'
| 'waiting'
| 'load'
| 'error'
| 'animationStart'
| 'animationEnd'
| 'animationIteration'
| 'transitionEnd'
| 'doubleClick'

type FireFunction = (element: HTMLElement, event: Event) => boolean
type FireObject = {
[K in EventType]: (element: HTMLElement, options?: {}) => boolean
}

/**
* Fire DOM events.
*/
export const fireEvent: FireFunction & FireObject

/**
* Unmounts React trees that were mounted with render.
*/
export function cleanup(): void

export function getQueriesForElement(element: HTMLElement): GetsAndQueries