Skip to content

fix: typescript definitions for suggestions #630

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
Jun 13, 2020
Merged

fix: typescript definitions for suggestions #630

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
d6871aa
fix: fix typescript definitions for suggestions
marcosvega91 Jun 13, 2020
ea1a0ec
fix: add lowercase methods and make variant optional
marcosvega91 Jun 13, 2020
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 src/suggestions.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ function canSuggest(currentMethod, requestedMethod, data) {
return data && (!requestedMethod || requestedMethod === currentMethod)
}

export function getSuggestedQuery(element, variant, method) {
export function getSuggestedQuery(element, variant = 'get', method) {
// don't create suggestions for script and style elements
if (element.matches(DEFAULT_IGNORE_TAGS)) {
return undefined
Expand Down
32 changes: 31 additions & 1 deletion types/suggestions.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,34 @@ export interface Suggestion {
toString(): string
}

export function getSuggestedQuery(element: HTMLElement): Suggestion | undefined
export type Variant =
| 'get'
| 'getAll'
| 'query'
| 'queryAll'
| 'find'
| 'findAll'

export type Method =
| 'Role'
| 'role'
| 'LabelText'
| 'labeltext'
| 'PlaceholderText'
| 'placeholdertext'
| 'Text'
| 'text'
| 'DisplayValue'
| 'displayvalue'
| 'AltText'
| 'alttext'
| 'Title'
| 'title'
| 'TestId'
| 'testtd'

export function getSuggestedQuery(
element: HTMLElement,
variant?: Variant,
method?: Method,
): Suggestion | undefined