Skip to content

Commit 71dc7e0

Browse files
sainthkhsainthkh
committed
Add missing types.
1 parent 6ceb0ed commit 71dc7e0

File tree

2 files changed

+146
-0
lines changed

2 files changed

+146
-0
lines changed

‎cli/types/cypress.d.ts‎

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3024,6 +3024,22 @@ declare namespace Cypress {
30243024
* @see https://on.cypress.io/assertions
30253025
*/
30263026
(chainer: 'be.undefined'): Chainable<Subject>
3027+
/**
3028+
* Asserts that the target is strictly (`===`) equal to null.
3029+
* @example
3030+
* cy.wrap(null).should('be.null')
3031+
* @see http://chaijs.com/api/bdd/#method_null
3032+
* @see https://on.cypress.io/assertions
3033+
*/
3034+
(chainer: 'be.null'): Chainable<Subject>
3035+
/**
3036+
* Asserts that the target is strictly (`===`) equal to NaN.
3037+
* @example
3038+
* cy.wrap(NaN).should('be.NaN')
3039+
* @see http://chaijs.com/api/bdd/#method_null
3040+
* @see https://on.cypress.io/assertions
3041+
*/
3042+
(chainer: 'be.NaN'): Chainable<Subject>
30273043
/**
30283044
* Asserts that the target is a number or a date greater than or equal to the given number or date `start`, and less than or equal to the given number or date `finish` respectively.
30293045
* However, it’s often best to assert that the target is equal to its expected value.
@@ -3549,6 +3565,22 @@ declare namespace Cypress {
35493565
* @see https://on.cypress.io/assertions
35503566
*/
35513567
(chainer: 'not.be.undefined'): Chainable<Subject>
3568+
/**
3569+
* Asserts that the target is strictly (`===`) equal to null.
3570+
* @example
3571+
* cy.wrap(null).should('not.be.null')
3572+
* @see http://chaijs.com/api/bdd/#method_null
3573+
* @see https://on.cypress.io/assertions
3574+
*/
3575+
(chainer: 'not.be.null'): Chainable<Subject>
3576+
/**
3577+
* Asserts that the target is strictly (`===`) equal to NaN.
3578+
* @example
3579+
* cy.wrap(NaN).should('not.be.NaN')
3580+
* @see http://chaijs.com/api/bdd/#method_nan
3581+
* @see https://on.cypress.io/assertions
3582+
*/
3583+
(chainer: 'not.be.NaN'): Chainable<Subject>
35523584
/**
35533585
* Asserts that the target is not a number or a date greater than or equal to the given number or date `start`, and less than or equal to the given number or date `finish` respectively.
35543586
* However, it’s often best to assert that the target is equal to its expected value.
@@ -3979,6 +4011,60 @@ declare namespace Cypress {
39794011
* @see https://on.cypress.io/assertions
39804012
*/
39814013
(chainer: 'returned' | 'have.returned', value: any): Chainable<Subject>
4014+
/**
4015+
* Assert spy was called before anotherSpy, and no spy calls occurred between spy and anotherSpy.
4016+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledimmediatelybeforeanotherspy
4017+
* @see https://on.cypress.io/assertions
4018+
*/
4019+
(chainer: 'be.calledImmediatelyBefore' | 'have.been.calledImmediatelyBefore', anotherSpy: sinon.SinonSpy): Chainable<Subject>
4020+
/**
4021+
* Assert spy was called after anotherSpy, and no spy calls occurred between anotherSpy and spy.
4022+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledimmediatelyafteranotherspy
4023+
* @see https://on.cypress.io/assertions
4024+
*/
4025+
(chainer: 'be.calledImmediatelyAfter' | 'have.been.calledImmediatelyAfter', anotherSpy: sinon.SinonSpy): Chainable<Subject>
4026+
/**
4027+
* Assert the spy was always called with obj as this
4028+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwayscalledonobj
4029+
* @see https://on.cypress.io/assertions
4030+
*/
4031+
(chainer: 'be.always.calledOn' | 'always.have.been.calledOn', obj: any): Chainable<Subject>
4032+
/**
4033+
* Assert spy was called at least once with the provided arguments.
4034+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwitharg1-arg2-
4035+
* @see https://on.cypress.io/assertions
4036+
*/
4037+
(chainer: 'be.calledWith' | 'have.been.calledWith', ...args: any[]): Chainable<Subject>
4038+
/**
4039+
* Assert spy was always called with the provided arguments (and possibly others).
4040+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwayscalledwitharg1-arg2-
4041+
* @see https://on.cypress.io/assertions
4042+
*/
4043+
(chainer: 'be.always.calledWith' | 'always.have.been.calledWith', ...args: any[]): Chainable<Subject>
4044+
/**
4045+
* Assert spy was called at exactly once with the provided arguments.
4046+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwitharg1-arg2-
4047+
* @see https://on.cypress.io/assertions
4048+
*/
4049+
(chainer: 'be.calledOnceWith' | 'have.been.calledOnceWith', ...args: any[]): Chainable<Subject>
4050+
/**
4051+
* Assert spy was always called with the exact provided arguments.
4052+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwayscalledwithexactlyarg1-arg2-
4053+
* @see https://on.cypress.io/assertions
4054+
*/
4055+
(chainer: 'be.always.calledWithExactly' | 'have.been.calledWithExactly', ...args: any[]): Chainable<Subject>
4056+
/**
4057+
* Assert spy was called at exactly once with the provided arguments.
4058+
* @see http://sinonjs.org/releases/v4.1.3/spies/#
4059+
* @see https://on.cypress.io/assertions
4060+
*/
4061+
(chainer: 'be.calledOnceWithExactly' | 'have.been.calledOnceWithExactly', ...args: any[]): Chainable<Subject>
4062+
/**
4063+
* Assert spy always returned the provided value.
4064+
* @see http://sinonjs.org/releases/v4.1.3/spies/#
4065+
* @see https://on.cypress.io/assertions
4066+
*/
4067+
(chainer: 'have.always.returned', obj: any): Chainable<Subject>
39824068

39834069
// sinon-chai.not
39844070
/**
@@ -4085,6 +4171,60 @@ declare namespace Cypress {
40854171
* @see https://on.cypress.io/assertions
40864172
*/
40874173
(chainer: 'not.returned' | 'not.have.returned', value: any): Chainable<Subject>
4174+
/**
4175+
* Assert spy was called before anotherSpy, and no spy calls occurred between spy and anotherSpy.
4176+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledimmediatelybeforeanotherspy
4177+
* @see https://on.cypress.io/assertions
4178+
*/
4179+
(chainer: 'not.be.calledImmediatelyBefore' | 'not.have.been.calledImmediatelyBefore', anotherSpy: sinon.SinonSpy): Chainable<Subject>
4180+
/**
4181+
* Assert spy was called after anotherSpy, and no spy calls occurred between anotherSpy and spy.
4182+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledimmediatelyafteranotherspy
4183+
* @see https://on.cypress.io/assertions
4184+
*/
4185+
(chainer: 'not.be.calledImmediatelyAfter' | 'not.have.been.calledImmediatelyAfter', anotherSpy: sinon.SinonSpy): Chainable<Subject>
4186+
/**
4187+
* Assert the spy was always called with obj as this
4188+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwayscalledonobj
4189+
* @see https://on.cypress.io/assertions
4190+
*/
4191+
(chainer: 'not.be.always.calledOn' | 'not.always.have.been.calledOn', obj: any): Chainable<Subject>
4192+
/**
4193+
* Assert spy was called at least once with the provided arguments.
4194+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwitharg1-arg2-
4195+
* @see https://on.cypress.io/assertions
4196+
*/
4197+
(chainer: 'not.be.calledWith' | 'not.have.been.calledWith', ...args: any[]): Chainable<Subject>
4198+
/**
4199+
* Assert spy was always called with the provided arguments (and possibly others).
4200+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwayscalledwitharg1-arg2-
4201+
* @see https://on.cypress.io/assertions
4202+
*/
4203+
(chainer: 'not.be.always.calledWith' | 'not.always.have.been.calledWith', ...args: any[]): Chainable<Subject>
4204+
/**
4205+
* Assert spy was called at exactly once with the provided arguments.
4206+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spycalledwitharg1-arg2-
4207+
* @see https://on.cypress.io/assertions
4208+
*/
4209+
(chainer: 'not.be.calledOnceWith' | 'not.have.been.calledOnceWith', ...args: any[]): Chainable<Subject>
4210+
/**
4211+
* Assert spy was always called with the exact provided arguments.
4212+
* @see http://sinonjs.org/releases/v4.1.3/spies/#spyalwayscalledwithexactlyarg1-arg2-
4213+
* @see https://on.cypress.io/assertions
4214+
*/
4215+
(chainer: 'not.be.always.calledWithExactly' | 'not.have.been.calledWithExactly', ...args: any[]): Chainable<Subject>
4216+
/**
4217+
* Assert spy was called at exactly once with the provided arguments.
4218+
* @see http://sinonjs.org/releases/v4.1.3/spies/#
4219+
* @see https://on.cypress.io/assertions
4220+
*/
4221+
(chainer: 'not.be.calledOnceWithExactly' | 'not.have.been.calledOnceWithExactly', ...args: any[]): Chainable<Subject>
4222+
/**
4223+
* Assert spy always returned the provided value.
4224+
* @see http://sinonjs.org/releases/v4.1.3/spies/#
4225+
* @see https://on.cypress.io/assertions
4226+
*/
4227+
(chainer: 'not.have.always.returned', obj: any): Chainable<Subject>
40884228

40894229
// jquery-chai
40904230
/**

‎cli/types/tests/chainer-examples.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,12 @@ cy.wrap(true).should('not.be.undefined')
229229

230230
cy.wrap(3).should('not.be.within', 5, 10)
231231

232+
cy.wrap(null).should('be.null')
233+
cy.wrap(123).should('not.be.null')
234+
235+
cy.wrap(NaN).should('be.NaN')
236+
cy.wrap('cypress').should('not.be.NaN')
237+
232238
;
233239
() => {
234240
let dots = ''

0 commit comments

Comments
 (0)