mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
4b29f4bd1d
* feat: Add type definitions for npm module `ospec`
* Apply suggestions from code review
Co-Authored-By: Isiah Meadows <contact@isiahmeadows.com>
* fix: Disable no-unnecessary-generics for dummy o.spy() generation
* fix: Rename namespace to match thew global export's name
* fix: Properly guard against non-newable functions
...and relax TypeScript version requirement to 3.1
* feat: Simplify the assertion signature
* fix: Error in `tslint:disable` syntax
* feat: Make .notEquals() and .notDeepEquals() type safe
* feat: Update the `Definer` type...
* Allow tests to return any `PromiseLike` objects.
* Disallow anything but Error and null as argument for `done()`
* feat: Add tests for Definer` functions returning promises
* style: Prefer `import o = require('')` over `import o from` in test file
93 lines
3.6 KiB
TypeScript
93 lines
3.6 KiB
TypeScript
// Type definitions for ospec 4.0
|
|
// Project: https://github.com/MithrilJS/mithril.js/tree/next/ospec
|
|
// Definitions by: Már Örlygsson <https://github.com/maranomynet>
|
|
// Mike Linkovich <https://github.com/spacejack>
|
|
// Isiah Meadows <https://github.com/isiahmeadows>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
// TypeScript Version: 3.1
|
|
|
|
type ObjectConstructor = new (...args: any[]) => any;
|
|
|
|
declare namespace o {
|
|
type AssertionDescriber = (description: string) => void;
|
|
|
|
interface Spy<Args extends any[], Returns> {
|
|
(...args: Args): Returns;
|
|
/** The number of times the function has been called */
|
|
readonly callCount: number;
|
|
/** The arguments that were passed to the function in the last time it was called */
|
|
readonly args: Args;
|
|
/** List of arguments that were passed to the function each tine it was called */
|
|
readonly calls: Args[];
|
|
}
|
|
|
|
interface Assertion<T> {
|
|
/** Asserts that two values are strictly equal */
|
|
equals(expected: T): AssertionDescriber;
|
|
/** Asserts that two values are **not** strictly equal */
|
|
notEquals(value: T): AssertionDescriber;
|
|
|
|
/** Asserts that two objects are recursively equal */
|
|
deepEquals(this: Assertion<object>, expected: T): AssertionDescriber;
|
|
/** Asserts that two objects are **not** recursively equal */
|
|
notDeepEquals(this: Assertion<object>, value: T): AssertionDescriber;
|
|
|
|
/** Asserts that the function throws an error of a given type */
|
|
throws(this: Assertion<() => any>, error: string | ObjectConstructor): AssertionDescriber;
|
|
/** Asserts that the function does **not** throw an error of given type */
|
|
notThrows(this: Assertion<() => any>, error: string | ObjectConstructor): AssertionDescriber; // See above
|
|
}
|
|
|
|
type Definer = (done: (error?: Error | null) => void, timeout: (delay: number) => void) => void | PromiseLike<any>;
|
|
|
|
interface Result {
|
|
pass: boolean | null;
|
|
context: string;
|
|
message: string;
|
|
error: Error | null;
|
|
testError: Error | null;
|
|
}
|
|
|
|
type Reporter = (results: Result[]) => number;
|
|
|
|
interface Ospec {
|
|
/** Starts an assertion */
|
|
<T>(actual: T): Assertion<T>;
|
|
|
|
/** Defines a test */
|
|
(name: string, assertions: Definer): void;
|
|
|
|
/** Defines a group of tests */
|
|
spec(name: string, tests: () => void): void;
|
|
|
|
/** Defines code to be run at the beginning of a test group */
|
|
before(setup: Definer): void;
|
|
/** Defines code to be run before each test in a group */
|
|
beforeEach(teardown: Definer): void;
|
|
/** Defines code to be run at the end of a test group */
|
|
after(setup: Definer): void;
|
|
/** Defines code to be run after each test in a group */
|
|
afterEach(teardown: Definer): void;
|
|
|
|
/** Returns a function that records the number of times it gets called, and its arguments */
|
|
spy<A extends any[]>(): Spy<A, undefined>; // tslint:disable-line:no-unnecessary-generics
|
|
spy<A extends any[], R>(fn: (...args: A) => R): Spy<A, R>;
|
|
|
|
/** Amount of time (in milliseconds) to wait until bailing out of a test */
|
|
timeout(delay: number): void;
|
|
/** Configure the default amount of time (in milliseconds) to wait until bailing out of a group of tests */
|
|
specTimeout(delay: number): void;
|
|
|
|
/** Runs the test suite */
|
|
run(reporter?: Reporter): void;
|
|
/** Default reporter used by `o.run()` */
|
|
report: Reporter;
|
|
|
|
'new'(): Ospec;
|
|
}
|
|
}
|
|
|
|
declare const o: o.Ospec;
|
|
export = o;
|
|
export as namespace o;
|