Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@types/jest

Package Overview
Dependencies
Maintainers
1
Versions
209
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/jest - npm Package Compare versions

Comparing version 20.0.3 to 20.0.4

871

jest/index.d.ts

@@ -1,6 +0,12 @@

// Type definitions for Jest 20.0.5
// Type definitions for Jest 20.0
// Project: http://facebook.github.io/jest/
// Definitions by: Asana <https://asana.com>, Ivo Stratev <https://github.com/NoHomey>, jwbay <https://github.com/jwbay>, Alexey Svetliakov <https://github.com/asvetliakov>, Alex Jover Morales <https://github.com/alexjoverm>, Allan Lukwago <https://github.com/epicallan>
// Definitions by: Asana <https://asana.com>
// Ivo Stratev <https://github.com/NoHomey>
// jwbay <https://github.com/jwbay>
// Alexey Svetliakov <https://github.com/asvetliakov>
// Alex Jover Morales <https://github.com/alexjoverm>
// Allan Lukwago <https://github.com/epicallan>
// Ika <https://github.com/ikatyang>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.1
// TypeScript Version: 2.2

@@ -23,5 +29,11 @@ declare var beforeAll: jest.Lifecycle;

interface NodeRequire {
/** Returns the actual module instead of a mock, bypassing all checks on whether the module should receive a mock implementation or not. */
/**
* Returns the actual module instead of a mock, bypassing all checks on
* whether the module should receive a mock implementation or not.
*/
requireActual(moduleName: string): any;
/** Returns a mock module instead of the actual module, bypassing all checks on whether the module should be required normally or not. */
/**
* Returns a mock module instead of the actual module, bypassing all checks
* on whether the module should be required normally or not.
*/
requireMock(moduleName: string): any;

@@ -31,7 +43,13 @@ }

declare namespace jest {
/** Provides a way to add Jasmine-compatible matchers into your Jest context. */
/**
* Provides a way to add Jasmine-compatible matchers into your Jest context.
*/
function addMatchers(matchers: jasmine.CustomMatcherFactories): typeof jest;
/** Disables automatic mocking in the module loader. */
/**
* Disables automatic mocking in the module loader.
*/
function autoMockOff(): typeof jest;
/** Enables automatic mocking in the module loader. */
/**
* Enables automatic mocking in the module loader.
*/
function autoMockOn(): typeof jest;

@@ -42,49 +60,107 @@ /**

function clearAllMocks(): typeof jest;
/** Clears the mock.calls and mock.instances properties of all mocks. Equivalent to calling .mockClear() on every mocked function. */
/**
* Clears the mock.calls and mock.instances properties of all mocks.
* Equivalent to calling .mockClear() on every mocked function.
*/
function resetAllMocks(): typeof jest;
/** Removes any pending timers from the timer system. If any timers have been scheduled, they will be cleared and will never have the opportunity to execute in the future. */
/**
* Removes any pending timers from the timer system. If any timers have
* been scheduled, they will be cleared and will never have the opportunity
* to execute in the future.
*/
function clearAllTimers(): typeof jest;
/** Indicates that the module system should never return a mocked version of the specified module, including all of the specificied module's dependencies. */
/**
* Indicates that the module system should never return a mocked version
* of the specified module, including all of the specificied module's dependencies.
*/
function deepUnmock(moduleName: string): typeof jest;
/** Disables automatic mocking in the module loader. */
/**
* Disables automatic mocking in the module loader.
*/
function disableAutomock(): typeof jest;
/** Mocks a module with an auto-mocked version when it is being required. */
/**
* Mocks a module with an auto-mocked version when it is being required.
*/
function doMock(moduleName: string): typeof jest;
/** Indicates that the module system should never return a mocked version of the specified module from require() (e.g. that it should always return the real module). */
/**
* Indicates that the module system should never return a mocked version
* of the specified module from require() (e.g. that it should always return the real module).
*/
function dontMock(moduleName: string): typeof jest;
/** Enables automatic mocking in the module loader. */
/**
* Enables automatic mocking in the module loader.
*/
function enableAutomock(): typeof jest;
/** Creates a mock function. Optionally takes a mock implementation. */
/**
* Creates a mock function. Optionally takes a mock implementation.
*/
function fn<T extends {}>(implementation: (...args: any[]) => T): Mock<T>;
function fn<T>(implementation?: Function): Mock<T>;
/** Use the automatic mocking system to generate a mocked version of the given module. */
function fn<T>(implementation?: (...args: any[]) => any): Mock<T>;
/**
* Use the automatic mocking system to generate a mocked version of the given module.
*/
function genMockFromModule<T>(moduleName: string): T;
/** Returns whether the given function is a mock function. */
/**
* Returns whether the given function is a mock function.
*/
function isMockFunction(fn: any): fn is Mock<any>;
/** Mocks a module with an auto-mocked version when it is being required. */
/**
* Mocks a module with an auto-mocked version when it is being required.
*/
function mock(moduleName: string, factory?: any, options?: MockOptions): typeof jest;
/** Resets the module registry - the cache of all required modules. This is useful to isolate modules where local state might conflict between tests. */
/**
* Resets the module registry - the cache of all required modules. This is
* useful to isolate modules where local state might conflict between tests.
*/
function resetModuleRegistry(): typeof jest;
/** Resets the module registry - the cache of all required modules. This is useful to isolate modules where local state might conflict between tests. */
/**
* Resets the module registry - the cache of all required modules. This is
* useful to isolate modules where local state might conflict between tests.
*/
function resetModules(): typeof jest;
/** Exhausts tasks queued by setImmediate(). */
/**
* Exhausts tasks queued by setImmediate().
*/
function runAllImmediates(): typeof jest;
/** Exhausts the micro-task queue (usually interfaced in node via process.nextTick). */
/**
* Exhausts the micro-task queue (usually interfaced in node via process.nextTick).
*/
function runAllTicks(): typeof jest;
/** Exhausts the macro-task queue (i.e., all tasks queued by setTimeout() and setInterval()). */
/**
* Exhausts the macro-task queue (i.e., all tasks queued by setTimeout() and setInterval()).
*/
function runAllTimers(): typeof jest;
/** Executes only the macro-tasks that are currently pending (i.e., only the tasks that have been queued by setTimeout() or setInterval() up to this point).
* If any of the currently pending macro-tasks schedule new macro-tasks, those new tasks will not be executed by this call. */
/**
* Executes only the macro-tasks that are currently pending (i.e., only the
* tasks that have been queued by setTimeout() or setInterval() up to this point).
* If any of the currently pending macro-tasks schedule new macro-tasks,
* those new tasks will not be executed by this call.
*/
function runOnlyPendingTimers(): typeof jest;
/** Executes only the macro task queue (i.e. all tasks queued by setTimeout() or setInterval() and setImmediate()). */
/**
* Executes only the macro task queue (i.e. all tasks queued by setTimeout()
* or setInterval() and setImmediate()).
*/
function runTimersToTime(msToRun: number): typeof jest;
/** Explicitly supplies the mock object that the module system should return for the specified module. */
/**
* Explicitly supplies the mock object that the module system should return
* for the specified module.
*/
function setMock<T>(moduleName: string, moduleExports: T): typeof jest;
/** Creates a mock function similar to jest.fn but also tracks calls to object[methodName] */
/**
* Creates a mock function similar to jest.fn but also tracks calls to object[methodName]
*/
function spyOn<T extends {}, M extends keyof T>(object: T, method: M): SpyInstance<T[M]>;
/** Indicates that the module system should never return a mocked version of the specified module from require() (e.g. that it should always return the real module). */
/**
* Indicates that the module system should never return a mocked version of
* the specified module from require() (e.g. that it should always return the real module).
*/
function unmock(moduleName: string): typeof jest;
/** Instructs Jest to use fake versions of the standard timer functions. */
/**
* Instructs Jest to use fake versions of the standard timer functions.
*/
function useFakeTimers(): typeof jest;
/** Instructs Jest to use the real versions of the standard timer functions. */
/**
* Instructs Jest to use the real versions of the standard timer functions.
*/
function useRealTimers(): typeof jest;

@@ -96,20 +172,16 @@

interface EmptyFunction {
(): void;
}
type EmptyFunction = () => void;
interface DoneCallback {
(...args: any[]): any
(...args: any[]): any;
fail(error?: string | { message: string }): any;
}
interface ProvidesCallback {
(cb: DoneCallback): any;
}
type ProvidesCallback = (cb: DoneCallback) => any;
interface Lifecycle {
(fn: ProvidesCallback): any;
}
type Lifecycle = (fn: ProvidesCallback) => any;
/** Creates a test closure */
/**
* Creates a test closure
*/
interface It {

@@ -124,3 +196,5 @@ /**

(name: string, fn?: ProvidesCallback, timeout?: number): void;
/** Only runs this test in the current file. */
/**
* Only runs this test in the current file.
*/
only: It;

@@ -132,3 +206,3 @@ skip: It;

interface Describe {
(name: string, fn: EmptyFunction): void
(name: string, fn: EmptyFunction): void;
only: Describe;

@@ -147,3 +221,5 @@ skip: Describe;

ensureNumbers(actual: any, expected: any, matcherName?: string): void;
/** get the type of a value with handling of edge cases like `typeof []` and `typeof null` */
/**
* get the type of a value with handling of edge cases like `typeof []` and `typeof null`
*/
getType(value: any): string;

@@ -156,7 +232,7 @@ matcherHint(matcherName: string, received?: string, expected?: string, options?: { secondArgument?: string, isDirectExpectCall?: boolean }): string;

stringify(object: {}, maxDepth?: number): string;
}
};
}
interface ExpectExtendMap {
[key: string]: (this: MatcherUtils, received: any, actual: any) => { message: () => string, pass: boolean };
[key: string]: (this: MatcherUtils, received: any, actual: any) => { message(): string, pass: boolean };
}

@@ -173,3 +249,3 @@

min?: boolean;
plugins?: Array<SnapshotSerializerPlugin>
plugins?: SnapshotSerializerPlugin[];
printFunctionName?: boolean;

@@ -199,30 +275,57 @@ theme?: SnapshotSerializerOptionsTheme;

interface SnapshotSerializerPlugin {
print(val:any, serialize:((val:any) => string), indent:((str:string) => string), opts:SnapshotSerializerOptions, colors: SnapshotSerializerColors) : string;
test(val:any) : boolean;
print(val: any, serialize: ((val: any) => string), indent: ((str: string) => string), opts: SnapshotSerializerOptions, colors: SnapshotSerializerColors): string;
test(val: any): boolean;
}
/** The `expect` function is used every time you want to test a value. You will rarely call `expect` by itself. */
/**
* The `expect` function is used every time you want to test a value.
* You will rarely call `expect` by itself.
*/
interface Expect {
/**
* The `expect` function is used every time you want to test a value. You will rarely call `expect` by itself.
* The `expect` function is used every time you want to test a value.
* You will rarely call `expect` by itself.
*
* @param {any} actual The value to apply matchers against.
*/
*/
(actual: any): Matchers<void>;
anything(): any;
/** Matches anything that was created with the given constructor. You can use it inside `toEqual` or `toBeCalledWith` instead of a literal value. */
/**
* Matches anything that was created with the given constructor.
* You can use it inside `toEqual` or `toBeCalledWith` instead of a literal value.
*/
any(classType: any): any;
/** Matches any array made up entirely of elements in the provided array. You can use it inside `toEqual` or `toBeCalledWith` instead of a literal value. */
/**
* Matches any array made up entirely of elements in the provided array.
* You can use it inside `toEqual` or `toBeCalledWith` instead of a literal value.
*/
arrayContaining(arr: any[]): any;
/** Verifies that a certain number of assertions are called during a test. This is often useful when testing asynchronous code, in order to make sure that assertions in a callback actually got called. */
/**
* Verifies that a certain number of assertions are called during a test.
* This is often useful when testing asynchronous code, in order to
* make sure that assertions in a callback actually got called.
*/
assertions(num: number): void;
/** Verifies that at least one assertion is called during a test. This is often useful when testing asynchronous code, in order to make sure that assertions in a callback actually got called. */
/**
* Verifies that at least one assertion is called during a test.
* This is often useful when testing asynchronous code, in order to
* make sure that assertions in a callback actually got called.
*/
hasAssertions(): void;
/** You can use `expect.extend` to add your own matchers to Jest. */
/**
* You can use `expect.extend` to add your own matchers to Jest.
*/
extend(obj: ExpectExtendMap): void;
/** Adds a module to format application-specific data structures for serialization. */
addSnapshotSerializer(serializer: SnapshotSerializerPlugin) : void;
/** Matches any object that recursively matches the provided keys. This is often handy in conjunction with other asymmetric matchers. */
/**
* Adds a module to format application-specific data structures for serialization.
*/
addSnapshotSerializer(serializer: SnapshotSerializerPlugin): void;
/**
* Matches any object that recursively matches the provided keys.
* This is often handy in conjunction with other asymmetric matchers.
*/
objectContaining(obj: {}): any;
/** Matches any string that contains the exact provided string */
/**
* Matches any string that contains the exact provided string
*/
stringMatching(str: string | RegExp): any;

@@ -232,67 +335,147 @@ }

interface Matchers<R> {
/** If you know how to test something, `.not` lets you test its opposite. */
/**
* If you know how to test something, `.not` lets you test its opposite.
*/
not: Matchers<R>;
/** Use resolves to unwrap the value of a fulfilled promise so any other matcher can be chained. If the promise is rejected the assertion fails. */
/**
* Use resolves to unwrap the value of a fulfilled promise so any other
* matcher can be chained. If the promise is rejected the assertion fails.
*/
resolves: Matchers<Promise<R>>;
/** Unwraps the reason of a rejected promise so any other matcher can be chained. If the promise is fulfilled the assertion fails. */
/**
* Unwraps the reason of a rejected promise so any other matcher can be chained.
* If the promise is fulfilled the assertion fails.
*/
rejects: Matchers<Promise<R>>;
lastCalledWith(...args: any[]): R;
/** Checks that a value is what you expect. It uses `===` to check strict equality. Don't use `toBe` with floating-point numbers. */
/**
* Checks that a value is what you expect. It uses `===` to check strict equality.
* Don't use `toBe` with floating-point numbers.
*/
toBe(expected: any): R;
/** Ensures that a mock function is called. */
/**
* Ensures that a mock function is called.
*/
toBeCalled(): R;
/** Ensure that a mock function is called with specific arguments. */
/**
* Ensure that a mock function is called with specific arguments.
*/
toBeCalledWith(...args: any[]): R;
/** Using exact equality with floating point numbers is a bad idea. Rounding means that intuitive things fail. */
/**
* Using exact equality with floating point numbers is a bad idea.
* Rounding means that intuitive things fail.
*/
toBeCloseTo(expected: number, delta?: number): R;
/** Ensure that a variable is not undefined. */
/**
* Ensure that a variable is not undefined.
*/
toBeDefined(): R;
/** When you don't care what a value is, you just want to ensure a value is false in a boolean context. */
/**
* When you don't care what a value is, you just want to
* ensure a value is false in a boolean context.
*/
toBeFalsy(): R;
/** For comparing floating point numbers. */
/**
* For comparing floating point numbers.
*/
toBeGreaterThan(expected: number): R;
/** For comparing floating point numbers. */
/**
* For comparing floating point numbers.
*/
toBeGreaterThanOrEqual(expected: number): R;
/** Ensure that an object is an instance of a class. This matcher uses `instanceof` underneath. */
toBeInstanceOf(expected: any): R
/** For comparing floating point numbers. */
/**
* Ensure that an object is an instance of a class.
* This matcher uses `instanceof` underneath.
*/
toBeInstanceOf(expected: any): R;
/**
* For comparing floating point numbers.
*/
toBeLessThan(expected: number): R;
/** For comparing floating point numbers. */
/**
* For comparing floating point numbers.
*/
toBeLessThanOrEqual(expected: number): R;
/** This is the same as `.toBe(null)` but the error messages are a bit nicer. So use `.toBeNull()` when you want to check that something is null. */
/**
* This is the same as `.toBe(null)` but the error messages are a bit nicer.
* So use `.toBeNull()` when you want to check that something is null.
*/
toBeNull(): R;
/** Use when you don't care what a value is, you just want to ensure a value is true in a boolean context. In JavaScript, there are six falsy values: `false`, `0`, `''`, `null`, `undefined`, and `NaN`. Everything else is truthy. */
/**
* Use when you don't care what a value is, you just want to ensure a value
* is true in a boolean context. In JavaScript, there are six falsy values:
* `false`, `0`, `''`, `null`, `undefined`, and `NaN`. Everything else is truthy.
*/
toBeTruthy(): R;
/** Used to check that a variable is undefined. */
/**
* Used to check that a variable is undefined.
*/
toBeUndefined(): R;
/** Used to check that a variable is NaN. */
/**
* Used to check that a variable is NaN.
*/
toBeNaN(): R;
/** Used when you want to check that an item is in a list. For testing the items in the list, this uses `===`, a strict equality check. */
/**
* Used when you want to check that an item is in a list.
* For testing the items in the list, this uses `===`, a strict equality check.
*/
toContain(expected: any): R;
/** Used when you want to check that an item is in a list. For testing the items in the list, this matcher recursively checks the equality of all fields, rather than checking for object identity. */
/**
* Used when you want to check that an item is in a list.
* For testing the items in the list, this matcher recursively checks the
* equality of all fields, rather than checking for object identity.
*/
toContainEqual(expected: any): R;
/** Used when you want to check that two objects have the same value. This matcher recursively checks the equality of all fields, rather than checking for object identity. */
/**
* Used when you want to check that two objects have the same value.
* This matcher recursively checks the equality of all fields, rather than checking for object identity.
*/
toEqual(expected: any): R;
/** Ensures that a mock function is called. */
/**
* Ensures that a mock function is called.
*/
toHaveBeenCalled(): R;
/** Ensures that a mock function is called an exact number of times. */
/**
* Ensures that a mock function is called an exact number of times.
*/
toHaveBeenCalledTimes(expected: number): R;
/** Ensure that a mock function is called with specific arguments. */
/**
* Ensure that a mock function is called with specific arguments.
*/
toHaveBeenCalledWith(...params: any[]): R;
/** If you have a mock function, you can use `.toHaveBeenLastCalledWith` to test what arguments it was last called with. */
/**
* If you have a mock function, you can use `.toHaveBeenLastCalledWith`
* to test what arguments it was last called with.
*/
toHaveBeenLastCalledWith(...params: any[]): R;
/** Used to check that an object has a `.length` property and it is set to a certain numeric value. */
/**
* Used to check that an object has a `.length` property
* and it is set to a certain numeric value.
*/
toHaveLength(expected: number): R;
toHaveProperty(propertyPath: string, value?: any): R;
/** Check that a string matches a regular expression. */
/**
* Check that a string matches a regular expression.
*/
toMatch(expected: string | RegExp): R;
/** Used to check that a JavaScript object matches a subset of the properties of an object */
/**
* Used to check that a JavaScript object matches a subset of the properties of an object
*/
toMatchObject(expected: {} | any[]): R;
/** This ensures that a value matches the most recent snapshot. Check out [the Snapshot Testing guide](http://facebook.github.io/jest/docs/snapshot-testing.html) for more information. */
/**
* This ensures that a value matches the most recent snapshot.
* Check out [the Snapshot Testing guide](http://facebook.github.io/jest/docs/snapshot-testing.html) for more information.
*/
toMatchSnapshot(snapshotName?: string): R;
/** Used to test that a function throws when it is called. */
/**
* Used to test that a function throws when it is called.
*/
toThrow(error?: string | Constructable | RegExp): R;
/** If you want to test that a specific error is thrown inside a function. */
/**
* If you want to test that a specific error is thrown inside a function.
*/
toThrowError(error?: string | Constructable | RegExp): R;
/** Used to test that a function throws a error matching the most recent snapshot when it is called. */
/**
* Used to test that a function throws a error matching the most recent snapshot when it is called.
*/
toThrowErrorMatchingSnapshot(): R;

@@ -302,3 +485,3 @@ }

interface Constructable {
new (...args: any[]): any
new (...args: any[]): any;
}

@@ -317,2 +500,3 @@

* Wrap module with mock definitions
*
* @example

@@ -333,4 +517,4 @@ * jest.mock("../api");

mockReset(): void;
mockImplementation(fn: Function): Mock<T>;
mockImplementationOnce(fn: Function): Mock<T>;
mockImplementation(fn: (...args: any[]) => any): Mock<T>;
mockImplementationOnce(fn: (...args: any[]) => any): Mock<T>;
mockReturnThis(): Mock<T>;

@@ -347,14 +531,19 @@ mockReturnValue(value: any): Mock<T>;

//Jest ships with a copy of Jasmine. They monkey-patch its APIs and divergence/deprecation are expected.
//Relevant parts of Jasmine's API are below so they can be changed and removed over time.
//This file can't reference jasmine.d.ts since the globals aren't compatible.
// Jest ships with a copy of Jasmine. They monkey-patch its APIs and divergence/deprecation are expected.
// Relevant parts of Jasmine's API are below so they can be changed and removed over time.
// This file can't reference jasmine.d.ts since the globals aren't compatible.
declare function spyOn(object: any, method: string): jasmine.Spy;
/** If you call the function pending anywhere in the spec body, no matter the expectations, the spec will be marked pending. */
/**
* If you call the function pending anywhere in the spec body,
* no matter the expectations, the spec will be marked pending.
*/
declare function pending(reason?: string): void;
/** Fails a test when called within one. */
/**
* Fails a test when called within one.
*/
declare function fail(error?: any): void;
declare namespace jasmine {
var DEFAULT_TIMEOUT_INTERVAL: number;
var clock: () => Clock;
let DEFAULT_TIMEOUT_INTERVAL: number;
function clock(): Clock;
function any(aclass: any): Any;

@@ -364,3 +553,3 @@ function anything(): Any;

function objectContaining(sample: any): ObjectContaining;
function createSpy(name: string, originalFn?: Function): Spy;
function createSpy(name: string, originalFn?: (...args: any[]) => any): Spy;
function createSpyObj(baseName: string, methodNames: any[]): any;

@@ -376,3 +565,6 @@ function createSpyObj<T>(baseName: string, methodNames: any[]): T;

uninstall(): void;
/** Calls to any registered callback are triggered when the clock is ticked forward via the jasmine.clock().tick function, which takes a number of milliseconds. */
/**
* Calls to any registered callback are triggered when the clock isticked forward
* via the jasmine.clock().tick function, which takes a number of milliseconds.
*/
tick(ms: number): void;

@@ -411,13 +603,31 @@ mockDate(date?: Date): void;

interface SpyAnd {
/** By chaining the spy with and.callThrough, the spy will still track all calls to it but in addition it will delegate to the actual implementation. */
/**
* By chaining the spy with and.callThrough, the spy will still track all
* calls to it but in addition it will delegate to the actual implementation.
*/
callThrough(): Spy;
/** By chaining the spy with and.returnValue, all calls to the function will return a specific value. */
/**
* By chaining the spy with and.returnValue, all calls to the function
* will return a specific value.
*/
returnValue(val: any): Spy;
/** By chaining the spy with and.returnValues, all calls to the function will return specific values in order until it reaches the end of the return values list. */
/**
* By chaining the spy with and.returnValues, all calls to the function
* will return specific values in order until it reaches the end of the return values list.
*/
returnValues(...values: any[]): Spy;
/** By chaining the spy with and.callFake, all calls to the spy will delegate to the supplied function. */
callFake(fn: Function): Spy;
/** By chaining the spy with and.throwError, all calls to the spy will throw the specified value. */
/**
* By chaining the spy with and.callFake, all calls to the spy
* will delegate to the supplied function.
*/
callFake(fn: (...args: any[]) => any): Spy;
/**
* By chaining the spy with and.throwError, all calls to the spy
* will throw the specified value.
*/
throwError(msg: string): Spy;
/** When a calling strategy is used for a spy, the original stubbing behavior can be returned at any time with and.stub. */
/**
* When a calling strategy is used for a spy, the original stubbing
* behavior can be returned at any time with and.stub.
*/
stub(): Spy;

@@ -427,17 +637,41 @@ }

interface Calls {
/** By chaining the spy with calls.any(), will return false if the spy has not been called at all, and then true once at least one call happens. */
/**
* By chaining the spy with calls.any(),
* will return false if the spy has not been called at all,
* and then true once at least one call happens.
*/
any(): boolean;
/** By chaining the spy with calls.count(), will return the number of times the spy was called */
/**
* By chaining the spy with calls.count(),
* will return the number of times the spy was called
*/
count(): number;
/** By chaining the spy with calls.argsFor(), will return the arguments passed to call number index */
/**
* By chaining the spy with calls.argsFor(),
* will return the arguments passed to call number index
*/
argsFor(index: number): any[];
/** By chaining the spy with calls.allArgs(), will return the arguments to all calls */
/**
* By chaining the spy with calls.allArgs(),
* will return the arguments to all calls
*/
allArgs(): any[];
/** By chaining the spy with calls.all(), will return the context (the this) and arguments passed all calls */
/**
* By chaining the spy with calls.all(), will return the
* context (the this) and arguments passed all calls
*/
all(): CallInfo[];
/** By chaining the spy with calls.mostRecent(), will return the context (the this) and arguments for the most recent call */
/**
* By chaining the spy with calls.mostRecent(), will return the
* context (the this) and arguments for the most recent call
*/
mostRecent(): CallInfo;
/** By chaining the spy with calls.first(), will return the context (the this) and arguments for the first call */
/**
* By chaining the spy with calls.first(), will return the
* context (the this) and arguments for the first call
*/
first(): CallInfo;
/** By chaining the spy with calls.reset(), will clears all tracking for a spy */
/**
* By chaining the spy with calls.reset(), will clears all tracking for a spy
*/
reset(): void;

@@ -447,7 +681,13 @@ }

interface CallInfo {
/** The context (the this) for the call */
/**
* The context (the this) for the call
*/
object: any;
/** All arguments passed to the call */
/**
* All arguments passed to the call
*/
args: any[];
/** The return value of the call */
/**
* The return value of the call
*/
returnValue: any;

@@ -460,15 +700,11 @@ }

interface CustomMatcherFactory {
(util: MatchersUtil, customEqualityTesters: Array<CustomEqualityTester>): CustomMatcher;
}
type CustomMatcherFactory = (util: MatchersUtil, customEqualityTesters: CustomEqualityTester[]) => CustomMatcher;
interface MatchersUtil {
equals(a: any, b: any, customTesters?: Array<CustomEqualityTester>): boolean;
contains<T>(haystack: ArrayLike<T> | string, needle: any, customTesters?: Array<CustomEqualityTester>): boolean;
buildFailureMessage(matcherName: string, isNot: boolean, actual: any, ...expected: Array<any>): string;
equals(a: any, b: any, customTesters?: CustomEqualityTester[]): boolean;
contains<T>(haystack: ArrayLike<T> | string, needle: any, customTesters?: CustomEqualityTester[]): boolean;
buildFailureMessage(matcherName: string, isNot: boolean, actual: any, ...expected: any[]): string;
}
interface CustomEqualityTester {
(first: any, second: any): boolean;
}
type CustomEqualityTester = (first: any, second: any) => boolean;

@@ -490,1 +726,364 @@ interface CustomMatcher {

}
declare namespace jest {
// types for implementing custom interfaces, from https://github.com/facebook/jest/tree/dd6c5c4/types
// https://facebook.github.io/jest/docs/en/configuration.html#transform-object-string-string
// const transformer: Transformer;
// https://facebook.github.io/jest/docs/en/configuration.html#reporters-array-modulename-modulename-options
// const reporter: Reporter;
// https://facebook.github.io/jest/docs/en/configuration.html#testrunner-string
// const testRunner: TestFramework;
// https://facebook.github.io/jest/docs/en/configuration.html#testresultsprocessor-string
// const testResultsProcessor: TestResultsProcessor;
// leave above declarations for referening type-dependencies
// .vscode/settings.json: "typescript.referencesCodeLens.enabled": true
// custom
// flow's Maybe type https://flow.org/en/docs/types/primitives/#toc-maybe-types
type Maybe<T> = void | null | undefined | T; // tslint:disable-line:void-return
type TestResultsProcessor = (testResult: AggregatedResult) => AggregatedResult;
type HasteResolver = any; // import HasteResolver from 'jest-resolve';
type ModuleMocker = any; // import {ModuleMocker} from 'jest-mock';
type ModuleMap = any; // import {ModuleMap} from 'jest-haste-map';
type HasteFS = any; // import {FS as HasteFS} from 'jest-haste-map';
type Runtime = any; // import Runtime from 'jest-runtime';
type Script = any; // import {Script} from 'vm';
// Config
type Path = string;
type Glob = string;
interface HasteConfig {
defaultPlatform?: Maybe<string>;
hasteImplModulePath?: string;
platforms?: string[];
providesModuleNodeModules: string[];
}
type ReporterConfig = [string, object];
type ConfigGlobals = object;
type SnapshotUpdateState = 'all' | 'new' | 'none';
interface GlobalConfig {
bail: boolean;
collectCoverage: boolean;
collectCoverageFrom: Glob[];
collectCoverageOnlyFrom: Maybe<{[key: string]: boolean}>;
coverageDirectory: string;
coverageReporters: string[];
coverageThreshold: {global: {[key: string]: number}};
expand: boolean;
forceExit: boolean;
logHeapUsage: boolean;
mapCoverage: boolean;
noStackTrace: boolean;
notify: boolean;
projects: Glob[];
replname: Maybe<string>;
reporters: ReporterConfig[];
rootDir: Path;
silent: boolean;
testNamePattern: string;
testPathPattern: string;
testResultsProcessor: Maybe<string>;
updateSnapshot: SnapshotUpdateState;
useStderr: boolean;
verbose: Maybe<boolean>;
watch: boolean;
watchman: boolean;
}
interface ProjectConfig {
automock: boolean;
browser: boolean;
cache: boolean;
cacheDirectory: Path;
clearMocks: boolean;
coveragePathIgnorePatterns: string[];
globals: ConfigGlobals;
haste: HasteConfig;
moduleDirectories: string[];
moduleFileExtensions: string[];
moduleLoader: Path;
moduleNameMapper: Array<[string, string]>;
modulePathIgnorePatterns: string[];
modulePaths: string[];
name: string;
resetMocks: boolean;
resetModules: boolean;
resolver: Maybe<Path>;
rootDir: Path;
roots: Path[];
setupFiles: Path[];
setupTestFrameworkScriptFile: Path;
skipNodeResolution: boolean;
snapshotSerializers: Path[];
testEnvironment: string;
testMatch: Glob[];
testPathIgnorePatterns: string[];
testRegex: string;
testRunner: string;
testURL: string;
timers: 'real' | 'fake';
transform: Array<[string, Path]>;
transformIgnorePatterns: Glob[];
unmockedModulePathPatterns: Maybe<string[]>;
}
// Console
type LogMessage = string;
interface LogEntry {
message: LogMessage;
origin: string;
type: LogType;
}
type LogType = 'log' | 'info' | 'warn' | 'error';
type ConsoleBuffer = LogEntry[];
// Context
interface Context {
config: ProjectConfig;
hasteFS: HasteFS;
moduleMap: ModuleMap;
resolver: HasteResolver;
}
// Environment
interface FakeTimers {
clearAllTimers(): void;
runAllImmediates(): void;
runAllTicks(): void;
runAllTimers(): void;
runTimersToTime(msToRun: number): void;
runOnlyPendingTimers(): void;
runWithRealTimers(callback: any): void;
useFakeTimers(): void;
useRealTimers(): void;
}
interface $JestEnvironment {
global: Global;
fakeTimers: FakeTimers;
testFilePath: string;
moduleMocker: ModuleMocker;
dispose(): void;
runScript(script: Script): any;
}
type Environment = $JestEnvironment;
// Global
type Global = object;
// Reporter
interface ReporterOnStartOptions {
estimatedTime: number;
showStatus: boolean;
}
// TestResult
interface RawFileCoverage {
path: string;
s: {[statementId: number]: number};
b: {[branchId: number]: number};
f: {[functionId: number]: number};
l: {[lineId: number]: number};
fnMap: {[functionId: number]: any};
statementMap: {[statementId: number]: any};
branchMap: {[branchId: number]: any};
inputSourceMap?: object;
}
interface RawCoverage {
[filePath: string]: RawFileCoverage;
}
interface FileCoverageTotal {
total: number;
covered: number;
skipped: number;
pct?: number;
}
interface CoverageSummary {
lines: FileCoverageTotal;
statements: FileCoverageTotal;
branches: FileCoverageTotal;
functions: FileCoverageTotal;
}
interface FileCoverage {
getLineCoverage(): object;
getUncoveredLines(): number[];
getBranchCoverageByLine(): object;
toJSON(): object;
merge(other: object): void;
computeSimpleTotals(property: string): FileCoverageTotal;
computeBranchTotals(): FileCoverageTotal;
resetHits(): void;
toSummary(): CoverageSummary;
}
interface CoverageMap {
merge(data: object): void;
getCoverageSummary(): FileCoverage;
data: RawCoverage;
addFileCoverage(fileCoverage: RawFileCoverage): void;
files(): string[];
fileCoverageFor(file: string): FileCoverage;
}
interface SerializableError {
code?: any;
message: string;
stack: Maybe<string>;
type?: string;
}
type Status = 'passed' | 'failed' | 'skipped' | 'pending';
type Bytes = number;
type Milliseconds = number;
interface AssertionResult {
ancestorTitles: string[];
duration?: Maybe<Milliseconds>;
failureMessages: string[];
fullName: string;
numPassingAsserts: number;
status: Status;
title: string;
}
interface AggregatedResult {
coverageMap?: Maybe<CoverageMap>;
numFailedTests: number;
numFailedTestSuites: number;
numPassedTests: number;
numPassedTestSuites: number;
numPendingTests: number;
numPendingTestSuites: number;
numRuntimeErrorTestSuites: number;
numTotalTests: number;
numTotalTestSuites: number;
snapshot: SnapshotSummary;
startTime: number;
success: boolean;
testResults: TestResult[];
wasInterrupted: boolean;
}
interface TestResult {
console: Maybe<ConsoleBuffer>;
coverage?: RawCoverage;
memoryUsage?: Bytes;
failureMessage: Maybe<string>;
numFailingTests: number;
numPassingTests: number;
numPendingTests: number;
perfStats: {
end: Milliseconds,
start: Milliseconds,
};
skipped: boolean;
snapshot: {
added: number,
fileDeleted: boolean,
matched: number,
unchecked: number,
unmatched: number,
updated: number,
};
sourceMaps: {[sourcePath: string]: string};
testExecError?: SerializableError;
testFilePath: string;
testResults: AssertionResult[];
}
interface SnapshotSummary {
added: number;
didUpdate: boolean;
failure: boolean;
filesAdded: number;
filesRemoved: number;
filesUnmatched: number;
filesUpdated: number;
matched: number;
total: number;
unchecked: number;
unmatched: number;
updated: number;
}
// TestRunner
interface Test {
context: Context;
duration?: number;
path: Path;
}
interface Reporter {
onTestResult?(test: Test, testResult: TestResult, aggregatedResult: AggregatedResult): void;
onRunStart?(results: AggregatedResult, options: ReporterOnStartOptions): void;
onTestStart?(test: Test): void;
onRunComplete?(contexts: Set<Context>, results: AggregatedResult): Maybe<Promise<void>>;
getLastError?(): Maybe<Error>;
}
type TestFramework = (
globalConfig: GlobalConfig,
config: ProjectConfig,
environment: Environment,
runtime: Runtime,
testPath: string,
) => Promise<TestResult>;
// Transform
interface TransformedSource {
code: string;
map: Maybe<object | string>;
}
interface TransformOptions {
instrument: boolean;
}
interface Transformer {
canInstrument?: boolean;
createTransformer?(options: any): Transformer;
getCacheKey?(
fileData: string,
filePath: Path,
configStr: string,
options: TransformOptions,
): string;
process(
sourceText: string,
sourcePath: Path,
config: ProjectConfig,
options?: TransformOptions,
): string | TransformedSource;
}
}

10

jest/package.json
{
"name": "@types/jest",
"version": "20.0.3",
"version": "20.0.4",
"description": "TypeScript definitions for Jest",

@@ -30,2 +30,6 @@ "license": "MIT",

"url": "https://github.com/epicallan"
},
{
"name": "Ika",
"url": "https://github.com/ikatyang"
}

@@ -41,4 +45,4 @@ ],

"peerDependencies": {},
"typesPublisherContentHash": "1e7d1097f469cec448692899d573d5f18bddcff0ed355f4d7393bfd922ef62fb",
"typeScriptVersion": "2.1"
"typesPublisherContentHash": "18205a870c42c57871e31db090a4999c2c57ca2c64dea83d16032dbe629c6fc3",
"typeScriptVersion": "2.2"
}

@@ -11,3 +11,3 @@ # Installation

Additional Details
* Last updated: Mon, 17 Jul 2017 16:47:59 GMT
* Last updated: Mon, 17 Jul 2017 19:27:11 GMT
* Dependencies: none

@@ -17,2 +17,2 @@ * Global values: afterAll, afterEach, beforeAll, beforeEach, describe, expect, fail, fdescribe, fit, it, jasmine, jest, pending, spyOn, test, xdescribe, xit, xtest

# Credits
These definitions were written by Asana <https://asana.com>, Ivo Stratev <https://github.com/NoHomey>, jwbay <https://github.com/jwbay>, Alexey Svetliakov <https://github.com/asvetliakov>, Alex Jover Morales <https://github.com/alexjoverm>, Allan Lukwago <https://github.com/epicallan>.
These definitions were written by Asana <https://asana.com>, Ivo Stratev <https://github.com/NoHomey>, jwbay <https://github.com/jwbay>, Alexey Svetliakov <https://github.com/asvetliakov>, Alex Jover Morales <https://github.com/alexjoverm>, Allan Lukwago <https://github.com/epicallan>, Ika <https://github.com/ikatyang>.
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc