mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-06-04 19:42:46 +08:00
Add QUnit.todo(name, callback) function signature
- see https://api.qunitjs.com/QUnit/todo for docs used @waratuman - I've only added this function to the interface, but I bumped the type definitions for QUnit at the top of the file from `v2.0.1` to `v2.5.0`. This may not accurately reflect the 2.5.0 QUnit api in full, fyi. (advise if this concerns you).
This commit is contained in:
17
types/qunit/index.d.ts
vendored
17
types/qunit/index.d.ts
vendored
@@ -1,4 +1,4 @@
|
||||
// Type definitions for QUnit v2.0.1
|
||||
// Type definitions for QUnit v2.5.0
|
||||
// Project: http://qunitjs.com/
|
||||
// Definitions by: James Bracy <https://github.com/waratuman>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
@@ -580,6 +580,21 @@ interface QUnit {
|
||||
*/
|
||||
testStart(callback: (details: { name: string; module: string;}) => void): void;
|
||||
|
||||
/**
|
||||
* Adds a test which expects at least one failing assertion during its run.
|
||||
*
|
||||
* Use this method to test a unit of code which is still under development
|
||||
* (in a “todo” state). The test will pass as long as one failing assertion
|
||||
* is present.
|
||||
*
|
||||
* If all assertions pass, then the test will fail signaling that QUnit.todo
|
||||
* should be replaced by QUnit.test.
|
||||
*
|
||||
* @param {string} Title of unit being tested
|
||||
* @param callback Function to close over assertions
|
||||
*/
|
||||
todo(name: string, callback?: (assert: Assert) => void): void;
|
||||
|
||||
/**
|
||||
* Are the test running from the server or not.
|
||||
*/
|
||||
|
||||
@@ -552,3 +552,7 @@ QUnit.module( "module", {
|
||||
QUnit.test( "test with beforeEach and afterEach", function( assert ) {
|
||||
assert.expect( 2 );
|
||||
});
|
||||
|
||||
QUnit.todo( "a todo test", function( assert ) {
|
||||
assert.equal( 0, 1, "0 does not equal 1, so this todo should pass" );
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user