Skip to content

fix: add more should interface definitions. #8068

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 7 commits into from
Jul 28, 2020
Merged

fix: add more should interface definitions. #8068

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
878a3af
Migrate code.
sainthkh Jul 23, 2020
d2535a3
Fix sinon-chai.
sainthkh Jul 23, 2020
6ceb0ed
Add new increase test.
sainthkh Jul 23, 2020
71dc7e0
Add missing types.
sainthkh Jul 24, 2020
8ef2327
Add more types.
sainthkh Jul 27, 2020
a98d142
Restore fallback.
sainthkh Jul 27, 2020
d9e9490
Fix lint.
sainthkh Jul 27, 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
Prev Previous commit
Next Next commit
Fix sinon-chai.
  • Loading branch information
@sainthkh
sainthkh committed Jul 24, 2020
commit d2535a302c4f16f95eeb96a4327b43ae9bed71dd
56 changes: 28 additions & 28 deletions cli/types/cypress.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3881,80 +3881,80 @@ declare namespace Cypress {
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwithnew
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.always.calledWithNew'): Chainable<Subject>
(chainer: 'be.always.calledWithNew' | 'always.have.been.calledWithNew'): Chainable<Subject>
/**
* Assert if spy was always called with matching arguments (and possibly others).
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwayscalledwithmatcharg1-arg2-
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.always.calledWithMatch', ...args: any[]): Chainable<Subject>
(chainer: 'be.always.calledWithMatch' | 'always.have.been.calledWithMatch', ...args: any[]): Chainable<Subject>
/**
* Assert spy always returned the provided value.
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwaysreturnedobj
* @see https://on.cypress.io/assertions
*/
(chainer: 'always.returned', value: any): Chainable<Subject>
(chainer: 'always.returned' | 'have.always.returned', value: any): Chainable<Subject>
/**
* `true` if the spy was called at least once
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalled
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.called'): Chainable<Subject>
(chainer: 'be.called' | 'have.been.called'): Chainable<Subject>
/**
* Assert spy was called after `anotherSpy`
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledafteranotherspy
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledAfter', spy: sinon.SinonSpy): Chainable<Subject>
(chainer: 'be.calledAfter' | 'have.been.calledAfter', spy: sinon.SinonSpy): Chainable<Subject>
/**
* Assert spy was called before `anotherSpy`
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledbeforeanotherspy
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledBefore', spy: sinon.SinonSpy): Chainable<Subject>
(chainer: 'be.calledBefore' | 'have.been.calledBefore', spy: sinon.SinonSpy): Chainable<Subject>
/**
* Assert spy was called at least once with `obj` as `this`. `calledOn` also accepts a matcher (see [matchers](http://sinonjs.org/releases/v4.1.3/spies/#matchers)).
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledonobj
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledOn', context: any): Chainable<Subject>
(chainer: 'be.calledOn' | 'have.been.calledOn', context: any): Chainable<Subject>
/**
* Assert spy was called exactly once
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledonce
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledOnce'): Chainable<Subject>
(chainer: 'be.calledOnce' | 'have.been.calledOnce'): Chainable<Subject>
/**
* Assert spy was called exactly three times
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledthrice
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledThrice'): Chainable<Subject>
(chainer: 'be.calledThrice' | 'have.been.calledThrice'): Chainable<Subject>
/**
* Assert spy was called exactly twice
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledtwice
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledTwice'): Chainable<Subject>
(chainer: 'be.calledTwice' | 'have.been.calledTwice'): Chainable<Subject>
/**
* Assert spy was called at least once with the provided arguments and no others.
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwithexactlyarg1-arg2-
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledWithExactly', ...args: any[]): Chainable<Subject>
(chainer: 'be.calledWithExactly' | 'have.been.calledWithExactly', ...args: any[]): Chainable<Subject>
/**
* Assert spy was called with matching arguments (and possibly others).
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwithmatcharg1-arg2-
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledWithMatch', ...args: any[]): Chainable<Subject>
(chainer: 'be.calledWithMatch' | 'have.been.calledWithMatch', ...args: any[]): Chainable<Subject>
/**
* Assert spy/stub was called the `new` operator.
* Beware that this is inferred based on the value of the this object and the spy function’s prototype, so it may give false positives if you actively return the right kind of object.
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwithnew
* @see https://on.cypress.io/assertions
*/
(chainer: 'be.calledWithNew'): Chainable<Subject>
(chainer: 'be.calledWithNew' | 'have.been.calledWithNew'): Chainable<Subject>
/**
* Assert spy always threw an exception.
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwaysthrew
Expand All @@ -3978,7 +3978,7 @@ declare namespace Cypress {
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyreturnedobj
* @see https://on.cypress.io/assertions
*/
(chainer: 'returned', value: any): Chainable<Subject>
(chainer: 'returned' | 'have.returned', value: any): Chainable<Subject>

// sinon-chai.not
/**
Expand All @@ -3987,80 +3987,80 @@ declare namespace Cypress {
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwithnew
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.always.calledWithNew'): Chainable<Subject>
(chainer: 'not.be.always.calledWithNew' | 'not.always.have.been.calledWithNew'): Chainable<Subject>
/**
* Assert if spy was not always called with matching arguments (and possibly others).
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwayscalledwithmatcharg1-arg2-
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.always.calledWithMatch', ...args: any[]): Chainable<Subject>
(chainer: 'not.be.always.calledWithMatch' | 'not.always.have.been.calledWithMatch', ...args: any[]): Chainable<Subject>
/**
* Assert spy not always returned the provided value.
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwaysreturnedobj
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.always.returned', value: any): Chainable<Subject>
(chainer: 'not.always.returned' | 'not.have.always.returned', value: any): Chainable<Subject>
/**
* `true` if the spy was not called at least once
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalled
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.called'): Chainable<Subject>
(chainer: 'not.be.called' | 'not.have.been.called'): Chainable<Subject>
/**
* Assert spy was not.called after `anotherSpy`
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledafteranotherspy
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledAfter', spy: sinon.SinonSpy): Chainable<Subject>
(chainer: 'not.be.calledAfter' | 'not.have.been.calledAfter', spy: sinon.SinonSpy): Chainable<Subject>
/**
* Assert spy was not called before `anotherSpy`
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledbeforeanotherspy
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledBefore', spy: sinon.SinonSpy): Chainable<Subject>
(chainer: 'not.be.calledBefore' | 'not.have.been.calledBefore', spy: sinon.SinonSpy): Chainable<Subject>
/**
* Assert spy was not called at least once with `obj` as `this`. `calledOn` also accepts a matcher (see [matchers](http://sinonjs.org/releases/v4.1.3/spies/#matchers)).
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledonobj
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledOn', context: any): Chainable<Subject>
(chainer: 'not.be.calledOn' | 'not.have.been.calledOn', context: any): Chainable<Subject>
/**
* Assert spy was not called exactly once
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledonce
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledOnce'): Chainable<Subject>
(chainer: 'not.be.calledOnce' | 'not.have.been.calledOnce'): Chainable<Subject>
/**
* Assert spy was not called exactly three times
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledthrice
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledThrice'): Chainable<Subject>
(chainer: 'not.be.calledThrice' | 'not.have.been.calledThrice'): Chainable<Subject>
/**
* Assert spy was not called exactly twice
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledtwice
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledTwice'): Chainable<Subject>
(chainer: 'not.be.calledTwice' | 'not.have.been.calledTwice'): Chainable<Subject>
/**
* Assert spy was not called at least once with the provided arguments and no others.
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwithexactlyarg1-arg2-
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledWithExactly', ...args: any[]): Chainable<Subject>
(chainer: 'not.be.calledWithExactly' | 'not.have.been.calledWithExactly', ...args: any[]): Chainable<Subject>
/**
* Assert spy was not called with matching arguments (and possibly others).
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwithmatcharg1-arg2-
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledWithMatch', ...args: any[]): Chainable<Subject>
(chainer: 'not.be.calledWithMatch' | 'not.have.been.calledWithMatch', ...args: any[]): Chainable<Subject>
/**
* Assert spy/stub was not called the `new` operator.
* Beware that this is inferred based on the value of the this object and the spy function’s prototype, so it may give false positives if you actively return the right kind of object.
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwithnew
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.be.calledWithNew'): Chainable<Subject>
(chainer: 'not.be.calledWithNew' | 'not.have.been.calledWithNew'): Chainable<Subject>
/**
* Assert spy did not always throw an exception.
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwaysthrew
Expand All @@ -4084,7 +4084,7 @@ declare namespace Cypress {
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyreturnedobj
* @see https://on.cypress.io/assertions
*/
(chainer: 'not.returned', value: any): Chainable<Subject>
(chainer: 'not.returned' | 'not.have.returned', value: any): Chainable<Subject>

// jquery-chai
/**
Expand Down
1 change: 1 addition & 0 deletions cli/types/tests/kitchen-sink.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ expect(stub).to.not.have.been.called
stub()
expect(stub).to.have.been.calledOnce
cy.wrap(stub).should('have.been.calledOnce')
cy.wrap(stub).should('be.calledOnce')

namespace EventInterfaceTests {
// window:confirm stubbing
Expand Down