Skip to content

findBy* typings: Remove Error as a possible return value #239

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 2 commits into from
Apr 12, 2019
Merged

findBy* typings: Remove Error as a possible return value #239

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a920e21
Remove Error as a possible return value since errors are thrown
bopfer Apr 12, 2019
b221f66
docs: fix a typo to kick the codecov build
alexkrolick Apr 12, 2019
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: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ your team down.

The `dom-testing-library` is a very light-weight solution for testing DOM nodes
(whether simulated with [`JSDOM`](https://github.com/jsdom/jsdom) as provided by
default with [jest][] or in the browser). The main utilities it provides involve
default with [Jest][] or in the browser). The main utilities it provides involve
querying the DOM for nodes in a way that's similar to how the user finds
elements on the page. In this way, the library helps ensure your tests give you
confidence in your UI code. The `dom-testing-library`'s primary guiding
Expand Down
8 changes: 4 additions & 4 deletions typings/queries.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export type FindAllByBoundAttribute = (
id: Matcher,
options?: MatcherOptions,
waitForElementOptions?: WaitForElementOptions
) => Promise<HTMLElement[]> | Error
) => Promise<HTMLElement[]>

export type GetByBoundAttribute = (
container: HTMLElement,
Expand All @@ -32,7 +32,7 @@ export type FindByBoundAttribute = (
id: Matcher,
options?: MatcherOptions,
waitForElementOptions?: WaitForElementOptions
) => Promise<HTMLElement> | Error
) => Promise<HTMLElement>

export type QueryByText = (
container: HTMLElement,
Expand All @@ -51,7 +51,7 @@ export type FindAllByText = (
id: Matcher,
options?: SelectorMatcherOptions,
waitForElementOptions?: WaitForElementOptions
) => Promise<HTMLElement[]> | Error
) => Promise<HTMLElement[]>

export type GetByText = (
container: HTMLElement,
Expand All @@ -64,7 +64,7 @@ export type FindByText = (
id: Matcher,
options?: SelectorMatcherOptions,
waitForElementOptions?: WaitForElementOptions
) => Promise<HTMLElement> | Error
) => Promise<HTMLElement>

export const getByLabelText: GetByText
export const getAllByLabelText: AllByText
Expand Down