Skip to content

Commit

Permalink
fix: revert "fix: types for Cypress.Commands.add (#20376)" (#21104)
Browse files Browse the repository at this point in the history
  • Loading branch information
flotwig authored Apr 15, 2022
1 parent a0ed4a0 commit 79267dd
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 15 deletions.
9 changes: 3 additions & 6 deletions cli/types/cypress.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,10 @@ declare namespace Cypress {
type PrevSubject = keyof PrevSubjectMap
type TestingType = 'e2e' | 'component'
type PluginConfig = (on: PluginEvents, config: PluginConfigOptions) => void | ConfigOptions | Promise<ConfigOptions>
interface JQueryWithSelector<TElement = HTMLElement> extends JQuery<TElement> {
selector?: string | null
}

interface PrevSubjectMap<O = unknown> {
optional: O
element: JQueryWithSelector
element: JQuery
document: Document
window: Window
}
Expand Down Expand Up @@ -469,9 +467,8 @@ declare namespace Cypress {
Commands: {
add<T extends keyof Chainable>(name: T, fn: CommandFn<T>): void
add<T extends keyof Chainable>(name: T, options: CommandOptions & {prevSubject: false}, fn: CommandFn<T>): void
add<T extends keyof Chainable, S = any>(name: T, options: CommandOptions & {prevSubject: true}, fn: CommandFnWithSubject<T, S>): void
add<T extends keyof Chainable, S extends PrevSubject>(
name: T, options: CommandOptions & { prevSubject: S | ['optional'] }, fn: CommandFnWithSubject<T, PrevSubjectMap[S]>,
name: T, options: CommandOptions & { prevSubject: true | S | ['optional'] }, fn: CommandFnWithSubject<T, PrevSubjectMap[S]>,
): void
add<T extends keyof Chainable, S extends PrevSubject>(
name: T, options: CommandOptions & { prevSubject: S[] }, fn: CommandFnWithSubject<T, PrevSubjectMap<void>[S]>,
Expand Down
15 changes: 6 additions & 9 deletions cli/types/tests/cypress-tests.ts
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ namespace CypressCommandsTests {
arg // $ExpectType string
})
Cypress.Commands.add('newCommand', { prevSubject: true }, (subject, arg) => {
subject // $ExpectType any
subject // $ExpectType unknown
arg // $ExpectType string
return
})
Expand Down Expand Up @@ -113,13 +113,11 @@ namespace CypressCommandsTests {
arg // $ExpectType string
})
Cypress.Commands.add('newCommand', { prevSubject: 'element' }, (subject, arg) => {
subject // $ExpectType JQueryWithSelector<HTMLElement>
subject.selector // $ExpectType string | null | undefined
subject // $ExpectType JQuery<HTMLElement>
arg // $ExpectType string
})
Cypress.Commands.add('newCommand', { prevSubject: ['element'] }, (subject, arg) => {
subject // $ExpectType JQueryWithSelector<HTMLElement>
subject.selector // $ExpectType string | null | undefined
subject // $ExpectType JQuery<HTMLElement>
arg // $ExpectType string
})
Cypress.Commands.add('newCommand', { prevSubject: ['element', 'document', 'window'] }, (subject, arg) => {
Expand All @@ -128,8 +126,7 @@ namespace CypressCommandsTests {
} else if (subject instanceof Document) {
subject // $ExpectType Document
} else {
subject // $ExpectType JQueryWithSelector<HTMLElement>
subject.selector // $ExpectType string | null | undefined
subject // $ExpectType JQuery<HTMLElement>
}
arg // $ExpectType string
})
Expand All @@ -139,7 +136,7 @@ namespace CypressCommandsTests {
} else if (subject instanceof Document) {
subject // $ExpectType Document
} else if (subject) {
subject // $ExpectType JQueryWithSelector<HTMLElement>
subject // $ExpectType JQuery<HTMLElement>
} else {
subject // $ExpectType void
}
Expand Down Expand Up @@ -274,7 +271,7 @@ namespace CypressCommandsTests {
originalFn.apply(this, [arg]) // $ExpectType Chainable<number>
})
Cypress.Commands.overwrite<'type', 'element'>('type', (originalFn, element, text, options?: Partial<Cypress.TypeOptions & {sensitive: boolean}>) => {
element // $ExpectType JQueryWithSelector<HTMLElement>
element // $ExpectType JQuery<HTMLElement>
text // $ExpectType string

if (options && options.sensitive) {
Expand Down

3 comments on commit 79267dd

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 79267dd Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the linux x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/9.5.5/linux-x64/develop-79267ddc0fdc5e82fcd2fba2e08ecd1e7a5c362e/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 79267dd Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the darwin x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/9.5.5/darwin-x64/develop-79267ddc0fdc5e82fcd2fba2e08ecd1e7a5c362e/cypress.tgz

@cypress-bot
Copy link
Contributor

@cypress-bot cypress-bot bot commented on 79267dd Apr 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Circle has built the win32 x64 version of the Test Runner.

Learn more about this pre-release platform-specific build at https://on.cypress.io/installing-cypress#Install-pre-release-version.

Run this command to install the pre-release locally:

npm install https://cdn.cypress.io/beta/npm/9.5.5/win32-x64/develop-79267ddc0fdc5e82fcd2fba2e08ecd1e7a5c362e/cypress.tgz

Please sign in to comment.