(TS) Type SelectorMatcherOptions is missing timeout

[ShimiTheFirst]

• cypress-testing-library version: 3.0.1
• node version: 10.13.0
• yarn version: 1.13.0

Relevant code or config

cy.queryByText("foo", { timeout: 100 })

What you did:
Tried to change the value of the timeout option on queryByText.

What happened:
The test correctly waited for the set amount of time (100ms) but TS validation reports an error:

Problem description:
Queries using the SelectorMatcherOptions type are missing the type definition for the timeout option.

Suggested solution:
If this is not intentional, take the same approach as for MatcherOptions in #28 – update typings/index.d.ts.

How it is now:

import {
  SelectorMatcherOptions,
  Matcher,
  MatcherOptions as DTLMatcherOptions,
  getByTestId,
} from 'dom-testing-library'

export interface CTLMatcherOptions {
  timeout?: number
}

export type MatcherOptions = DTLMatcherOptions | CTLMatcherOptions

How it could be:

import {
  SelectorMatcherOptions as DTLSelectorMatcherOptions,
  Matcher,
  MatcherOptions as DTLMatcherOptions,
  getByTestId,
} from 'dom-testing-library'


export interface CTLMatcherOptions {
  timeout?: number
}

export type MatcherOptions = DTLMatcherOptions | CTLMatcherOptions
export type SelectorMatcherOptions = DTLSelectorMatcherOptions | CTLMatcherOptions

[kentcdodds]

Thanks for this. Could you make a pull request for this?

[ShimiTheFirst]

I could try. It would be my very first PR though. I'll try to follow your course on egghead and contributing guide and see how far can I make it 🙂.

[kentcdodds]

Please note that I'm not currently using the TypeScript types in any project so I'll need another reviewer to review/merge these changes. Thanks!

[ppi-buck]

@ShimiTheFirst your solution looks fine to me. Just did just that locally and it works.

For a simple change like this I would simply use the GitHub web frontend to create a PR. In fact I did just that #48

[kentcdodds]

@all-contributors please add @ShimiTheFirst for bugs

[allcontributors]

@kentcdodds

I've put up a pull request to add @ShimiTheFirst! 🎉

[kentcdodds]

Thanks to both of you for this!