Skip to content

Commit 7f8a15e

Browse files
authored
fix: typescript definitions for suggestions (#630)
* fix: fix typescript definitions for suggestions * fix: add lowercase methods and make variant optional
1 parent 0158f0d commit 7f8a15e

File tree

2 files changed

+32
-2
lines changed

2 files changed

+32
-2
lines changed

src/suggestions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ function canSuggest(currentMethod, requestedMethod, data) {
7676
)
7777
}
7878

79-
export function getSuggestedQuery(element, variant, method) {
79+
export function getSuggestedQuery(element, variant = 'get', method) {
8080
// don't create suggestions for script and style elements
8181
if (element.matches(DEFAULT_IGNORE_TAGS)) {
8282
return undefined

types/suggestions.d.ts

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,34 @@ export interface Suggestion {
33
toString(): string
44
}
55

6-
export function getSuggestedQuery(element: HTMLElement): Suggestion | undefined
6+
export type Variant =
7+
| 'get'
8+
| 'getAll'
9+
| 'query'
10+
| 'queryAll'
11+
| 'find'
12+
| 'findAll'
13+
14+
export type Method =
15+
| 'Role'
16+
| 'role'
17+
| 'LabelText'
18+
| 'labeltext'
19+
| 'PlaceholderText'
20+
| 'placeholdertext'
21+
| 'Text'
22+
| 'text'
23+
| 'DisplayValue'
24+
| 'displayvalue'
25+
| 'AltText'
26+
| 'alttext'
27+
| 'Title'
28+
| 'title'
29+
| 'TestId'
30+
| 'testtd'
31+
32+
export function getSuggestedQuery(
33+
element: HTMLElement,
34+
variant?: Variant,
35+
method?: Method,
36+
): Suggestion | undefined

0 commit comments

Comments
 (0)