fix: typescript definitions for suggestions (#630)

* fix: fix typescript definitions for suggestions * fix: add lowercase methods and make variant optional
testing-library · Jun 13, 2020 · 7f8a15e · 7f8a15e
1 parent 0158f0d
commit 7f8a15e
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 2 deletions.
diff --git a/src/suggestions.js b/src/suggestions.js
@@ -76,7 +76,7 @@ function canSuggest(currentMethod, requestedMethod, data) {
   )
 }
 
-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

diff --git a/types/suggestions.d.ts b/types/suggestions.d.ts
@@ -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