/** * @deprecated Use {@link jasmine.ImplementationCallback} instead. */ type ImplementationCallback = jasmine.ImplementationCallback; /** * Create a group of specs (often called a suite). * @param description Textual description of the group * @param specDefinitions Function for Jasmine to invoke that will define inner suites a specs */ declare function describe(description: string, specDefinitions: () => void): void; /** * A focused `describe`. If suites or specs are focused, only those that are focused will be executed. * @param description Textual description of the group * @param specDefinitions Function for Jasmine to invoke that will define inner suites a specs */ declare function fdescribe(description: string, specDefinitions: () => void): void; /** * A temporarily disabled `describe`. Specs within an xdescribe will be marked pending and not executed. * @param description Textual description of the group * @param specDefinitions Function for Jasmine to invoke that will define inner suites a specs */ declare function xdescribe(description: string, specDefinitions: () => void): void; /** * Define a single spec. A spec should contain one or more expectations that test the state of the code. * A spec whose expectations all succeed will be passing and a spec with any failures will fail. * @param expectation Textual description of what this spec is checking * @param assertion Function that contains the code of your test. If not provided the test will be pending. * @param timeout Custom timeout for an async spec. */ declare function it(expectation: string, assertion?: jasmine.ImplementationCallback, timeout?: number): void; /** * A focused `it`. If suites or specs are focused, only those that are focused will be executed. * @param expectation Textual description of what this spec is checking * @param assertion Function that contains the code of your test. If not provided the test will be pending. * @param timeout Custom timeout for an async spec. */ declare function fit(expectation: string, assertion?: jasmine.ImplementationCallback, timeout?: number): void; /** * A temporarily disabled `it`. The spec will report as pending and will not be executed. * @param expectation Textual description of what this spec is checking * @param assertion Function that contains the code of your test. If not provided the test will be pending. * @param timeout Custom timeout for an async spec. */ declare function xit(expectation: string, assertion?: jasmine.ImplementationCallback, timeout?: number): void; /** * Mark a spec as pending, expectation results will be ignored. * If you call the function pending anywhere in the spec body, no matter the expectations, the spec will be marked pending. * @param reason Reason the spec is pending. */ declare function pending(reason?: string): void; /** * Sets a user-defined property that will be provided to reporters as * part of the properties field of SpecResult. * @since 3.6.0 */ declare function setSpecProperty(key: string, value: unknown): void; /** * Sets a user-defined property that will be provided to reporters as * part of the properties field of SuiteResult. * @since 3.6.0 */ declare function setSuiteProperty(key: string, value: unknown): void; /** * Run some shared setup before each of the specs in the describe in which it is called. * @param action Function that contains the code to setup your specs. * @param timeout Custom timeout for an async beforeEach. */ declare function beforeEach(action: jasmine.ImplementationCallback, timeout?: number): void; /** * Run some shared teardown after each of the specs in the describe in which it is called. * @param action Function that contains the code to teardown your specs. * @param timeout Custom timeout for an async afterEach. */ declare function afterEach(action: jasmine.ImplementationCallback, timeout?: number): void; /** * Run some shared setup once before all of the specs in the describe are run. * Note: Be careful, sharing the setup from a beforeAll makes it easy to accidentally leak state between your specs so that they erroneously pass or fail. * @param action Function that contains the code to setup your specs. * @param timeout Custom timeout for an async beforeAll. */ declare function beforeAll(action: jasmine.ImplementationCallback, timeout?: number): void; /** * Run some shared teardown once after all of the specs in the describe are run. * Note: Be careful, sharing the teardown from a afterAll makes it easy to accidentally leak state between your specs so that they erroneously pass or fail. * @param action Function that contains the code to teardown your specs. * @param timeout Custom timeout for an async afterAll */ declare function afterAll(action: jasmine.ImplementationCallback, timeout?: number): void; /** * Create an expectation for a spec. * @checkReturnValue see https://tsetse.info/check-return-value * @param spy */ declare function expect(spy: T | jasmine.Spy): jasmine.FunctionMatchers; /** * Create an expectation for a spec. * @checkReturnValue see https://tsetse.info/check-return-value * @param actual Actual computed value to test expectations against. */ declare function expect(actual: string): jasmine.Matchers; /** * Create an expectation for a spec. * @checkReturnValue see https://tsetse.info/check-return-value * @param actual */ declare function expect(actual: ArrayLike): jasmine.ArrayLikeMatchers; /** * Create an expectation for a spec. * @checkReturnValue see https://tsetse.info/check-return-value * @param actual Actual computed value to test expectations against. */ declare function expect(actual: T): jasmine.Matchers; /** * Create an expectation for a spec. */ declare function expect(): jasmine.NothingMatcher; /** * Create an asynchronous expectation for a spec. Note that the matchers * that are provided by an asynchronous expectation all return promises * which must be either returned from the spec or waited for using `await` * in order for Jasmine to associate them with the correct spec. * @checkReturnValue see https://tsetse.info/check-return-value * @param actual Actual computed value to test expectations against. */ declare function expectAsync(actual: T | PromiseLike): jasmine.AsyncMatchers; /** * Explicitly mark a spec as failed. * @param e Reason for the failure */ declare function fail(e?: any): void; /** * Action method that should be called when the async work is complete. */ interface DoneFn extends Function { (): void; /** fails the spec and indicates that it has completed. If the message is an Error, Error.message is used */ fail: (message?: Error | string) => void; } /** * Install a spy onto an existing object. * @param object The object upon which to install the `Spy`. * @param method The name of the method to replace with a `Spy`. */ declare function spyOn( object: T, method: T[K] extends Function ? K : never, ): jasmine.Spy< T[K] extends jasmine.Func ? T[K] : T[K] extends { new(...args: infer A): infer V } ? (...args: A) => V : never >; /** * Install a spy on a property installed with `Object.defineProperty` onto an existing object. * @param object The object upon which to install the `Spy`. * @param property The name of the property to replace with a `Spy`. * @param accessType The access type (get|set) of the property to `Spy` on. */ declare function spyOnProperty( object: T, property: K, accessType?: "get", ): jasmine.Spy<(this: T) => T[K]>; declare function spyOnProperty( object: T, property: K, accessType: "set", ): jasmine.Spy<(this: T, value: T[K]) => void>; interface ThrowUnlessFailure { /** * The name of the matcher that was executed for this expectation. */ matcherName: string; /** * The failure message for the expectation. */ message: string; /** * Whether the expectation passed or failed. */ passed: boolean; /** * Deprecated. If the expectation failed, what was the expected value. * @deprecated The expected and actual properties are deprecated and may be removed in a future release. */ expected: any; /** * Deprecated. If the expectation failed, what actual value was produced. * @deprecated The expected and actual properties are deprecated and may be removed in a future release. */ actual: any; } /** * Create an expectation for a spec and throw an error if it fails. * @checkReturnValue see https://tsetse.info/check-return-value * @param spy */ declare function throwUnless(spy: T | jasmine.Spy): jasmine.FunctionMatchers; /** * Create an expectation for a spec and throw an error if it fails. * @checkReturnValue see https://tsetse.info/check-return-value * @param actual Actual computed value to test expectations against. */ declare function throwUnless(actual: ArrayLike): jasmine.ArrayLikeMatchers; /** * Create an expectation for a spec and throw an error if it fails. * @checkReturnValue see https://tsetse.info/check-return-value * @param actual Actual computed value to test expectations against. */ declare function throwUnless(actual: T): jasmine.Matchers; /** * Create an asynchronous expectation for a spec and throw an error if it fails. * @param actual Actual computed value to test expectations against. */ declare function throwUnlessAsync(actual: T | PromiseLike): jasmine.AsyncMatchers; /** * Installs spies on all writable and configurable properties of an object. * @param object The object upon which to install the `Spy`s. * @param includeNonEnumerable Whether or not to add spies to non-enumerable properties. */ declare function spyOnAllFunctions(object: T, includeNonEnumerable?: boolean): jasmine.SpyObj; declare namespace jasmine { type Func = (...args: any[]) => any; // Use trick with prototype to allow abstract classes. // More info: https://stackoverflow.com/a/38642922/2009373 type Constructor = Function & { prototype: any }; type ImplementationCallback = (() => PromiseLike) | (() => void) | ((done: DoneFn) => void); type ExpectedRecursive = | T | ObjectContaining | AsymmetricMatcher | { [K in keyof T]: ExpectedRecursive | Any; }; type Expected = | T | ObjectContaining | AsymmetricMatcher | Any | Spy | { [K in keyof T]: ExpectedRecursive; }; type SpyObjMethodNames = T extends undefined ? readonly string[] | { [methodName: string]: any } : ( | ReadonlyArray | { [P in keyof T]?: // Value should be the return type (unless this is a method on Object.prototype, since all object literals contain those methods) T[P] extends Func ? (ReturnType | (P extends keyof Object ? Object[P] : never)) : any; } ); type SpyObjPropertyNames = T extends undefined ? readonly string[] | { [propertyName: string]: any } : ReadonlyArray | { [P in keyof T]?: T[P] }; /** * Configuration that can be used when configuring Jasmine via {@link jasmine.Env.configure} */ interface Configuration { /** * Whether to randomize spec execution order * @since 3.3.0 * @default true */ random?: boolean | undefined; /** * Seed to use as the basis of randomization. * Null causes the seed to be determined randomly at the start of execution. * @since 3.3.0 * @default null */ seed?: number | string | null | undefined; /** * Whether to stop execution of the suite after the first spec failure * @since 3.9.0 * @default false */ stopOnSpecFailure?: boolean | undefined; /** * Whether to forbid duplicate spec or suite names. If set to true, using * the same name multiple times in the same immediate parent suite is an * error. * @since 5.5.0 * @default false */ forbidDuplicateNames?: boolean | undefined; /** * Whether to fail the spec if it ran no expectations. By default * a spec that ran no expectations is reported as passed. Setting this * to true will report such spec as a failure. * @since 3.5.0 * @default false */ failSpecWithNoExpectations?: boolean | undefined; /** * Whether to cause specs to only have one expectation failure. * @since 3.3.0 * @default false */ stopSpecOnExpectationFailure?: boolean | undefined; /** * Function to use to filter specs * @since 3.3.0 * @default A function that always returns true. */ specFilter?: SpecFilter | undefined; /** * Whether or not reporters should hide disabled specs from their output. * Currently only supported by Jasmine's HTMLReporter * @since 3.3.0 * @default false */ hideDisabled?: boolean | undefined; /** * Set to provide a custom promise library that Jasmine will use if it needs * to create a promise. If not set, it will default to whatever global Promise * library is available (if any). * @since 3.5.0 * @default undefined */ Promise?: typeof Promise | undefined; /** * Clean closures when a suite is done running (done by clearing the stored function reference). * This prevents memory leaks, but you won't be able to run jasmine multiple times. * @since 3.10.0 * @default true */ autoCleanClosures?: boolean | undefined; } /** @deprecated Please use `Configuration` instead of `EnvConfiguration`. */ type EnvConfiguration = Configuration; /** * Get the currently booted mock {Clock} for this Jasmine environment. * @name jasmine.clock * @since 2.0.0 * @returns {Clock} */ function clock(): Clock; /** * @deprecated Private method that may be changed or removed in the future */ function DiffBuilder(): DiffBuilder; /** * Formats a value for display, taking into account the current set of * custom object formatters. * * @since 6.0.0 * @param value The value to pretty-print * @returns The pretty-printed value */ function pp(value: any): string; /** * That will succeed if the actual value being compared is an instance of the specified class/constructor. */ function any(aclass: Constructor | Symbol): AsymmetricMatcher; /** * That will succeed if the actual value being compared is not `null` and not `undefined`. */ function anything(): AsymmetricMatcher; /** * That will succeed if the actual value being compared is `true` or anything truthy. * @since 3.1.0 */ function truthy(): AsymmetricMatcher; /** * That will succeed if the actual value being compared is `null`, `undefined`, `0`, `false` or anything falsey. * @since 3.1.0 */ function falsy(): AsymmetricMatcher; /** * That will succeed if the actual value being compared is empty. * @since 3.1.0 */ function empty(): AsymmetricMatcher; /** * That will succeed if the actual value being compared is not empty. * @since 3.1.0 */ function notEmpty(): AsymmetricMatcher; /** * Get an AsymmetricMatcher, usable in any matcher * that passes if the actual value is the same as the sample as determined * by the `===` operator. * @param sample The value to compare the actual to. * @since 4.2.0 */ function is(sample: any): AsymmetricMatcher; /** * Get an {@link AsymmetricEqualityTester} that will succeed if the actual * value is an `Array` that contains at least the elements in the sample. * @since 2.2.0 * @param sample */ function arrayContaining(sample: ArrayLike): ArrayContaining; /** * Get an {@link AsymmetricEqualityTester} that will succeed if the actual * value is an `Array` that contains all of the elements in the sample in * any order. * @since 2.8.0 * @param sample */ function arrayWithExactContents(sample: ArrayLike): ArrayContaining; /** * Get an {@link AsymmetricEqualityTester} that will succeed if the actual * value being compared contains at least the specified keys and values. * @since 1.3.0 * @param sample - The subset of properties that _must_ be in the actual. */ function objectContaining(sample: { [K in keyof T]?: ExpectedRecursive }): ObjectContaining; /** * Get an {@link AsymmetricEqualityTester} that will succeed if every * key/value pair in the sample passes the deep equality comparison * with at least one key/value pair in the actual value being compared * @since 3.5.0 * @param sample - The subset of items that _must_ be in the actual. */ function mapContaining(sample: Map): AsymmetricMatcher>; /** * Get an {@link AsymmetricEqualityTester} that will succeed if every item * in the sample passes the deep equality comparison * with at least one item in the actual value being compared * @since 3.5.0 * @param sample - The subset of items that _must_ be in the actual. */ function setContaining(sample: Set): AsymmetricMatcher>; /** * Set the default spy strategy for the current scope of specs. * * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. * @param defaultStrategyFn - a function that assigns a strategy * @example * beforeEach(function() { * jasmine.setDefaultSpyStrategy(and => and.returnValue(true)); * }); */ function setDefaultSpyStrategy(fn?: (and: SpyAnd) => void): void; /** * Replaces Jasmine's global error handling with a spy. This prevents Jasmine * from treating uncaught exceptions and unhandled promise rejections * as spec failures and allows them to be inspected using the spy's * {@link Spy#calls|calls property} and related matchers such as * {@link matchers#toHaveBeenCalledWith|toHaveBeenCalledWith}. * * After installing the spy, spyOnGlobalErrorsAsync immediately calls its * argument, which must be an async or promise-returning function. The spy * will be passed as the first argument to that callback. Normal error * handling will be restored when the promise returned from the callback is * settled. * * When the JavaScript runtime reports an uncaught error or unhandled rejection, * the spy will be called with a single parameter representing Jasmine's best * effort at describing the error. This parameter may be of any type, because * JavaScript allows anything to be thrown or used as the reason for a * rejected promise, but Error instances and strings are most common. * * Note: The JavaScript runtime may deliver uncaught error events and unhandled * rejection events asynchronously, especially in browsers. If the event * occurs after the promise returned from the callback is settled, it won't * be routed to the spy even if the underlying error occurred previously. * It's up to you to ensure that all of the error/rejection events that you * want to handle have occurred before you resolve the promise returned from * the callback. * * You must ensure that the `it`/`beforeEach`/etc fn that called * `spyOnGlobalErrorsAsync` does not signal completion until after the * promise returned by `spyOnGlobalErrorsAsync` is resolved. Normally this is * done by `await`ing the returned promise. Leaving the global error spy * installed after the `it`/`beforeEach`/etc fn that installed it signals * completion is likely to cause problems and is not supported. * @param fn - A function to run, during which the global error spy will be effective * @example * it('demonstrates global error spies', async function() { * await jasmine.spyOnGlobalErrorsAsync(async function(globalErrorSpy) { * setTimeout(function() { * throw new Error('the expected error'); * }); * await new Promise(function(resolve) { * setTimeout(resolve); * }); * const expected = new Error('the expected error'); * expect(globalErrorSpy).toHaveBeenCalledWith(expected); * }); * }); */ function spyOnGlobalErrorsAsync(fn?: (globalErrorSpy: Spy<(error: Error) => void>) => Promise): Promise; /** * Add a custom spy strategy for the current scope of specs. * * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. * @since 3.5.0 * @param name - The name of the strategy (i.e. what you call from `and`) * @param factory - Factory function that returns the plan to be executed. */ function addSpyStrategy(name: string, factory: Fn): void; /** * Create a bare {@link Spy} object. This won't be installed anywhere and will not have any implementation behind it. * @since 1.3.0 * @param name - Name to give the spy. This will be displayed in failure messages. * @param originalFn - The "real" function. This will * be used for subsequent calls to the spy after you call * `mySpy.and.callThrough()`. In most cases you should omit this parameter. * The usual way to supply an original function is to call {@link spyOn} * instead of createSpy. */ function createSpy(name?: string, originalFn?: Fn): Spy; /** * Create an object with multiple {@link Spy}s as its members. * @since 1.3.0 * @param baseName - Base name for the spies in the object. * @param methodNames - Array of method names to create spies for, or Object whose keys will be method names and values the {@link Spy#and#returnValue|returnValue}. * @param propertyNames - Array of property names to create spies for, or Object whose keys will be propertynames and values the {@link Spy#and#returnValue|returnValue}. */ function createSpyObj(baseName: string, methodNames: SpyObjMethodNames, propertyNames?: SpyObjPropertyNames): any; /** * Create an object with multiple {@link Spy}s as its members. * @since 1.3.0 * @param baseName - Base name for the spies in the object. * @param methodNames - Array of method names to create spies for, or Object whose keys will be method names and values the {@link Spy#and#returnValue|returnValue}. * @param propertyNames - Array of property names to create spies for, or Object whose keys will be propertynames and values the {@link Spy#and#returnValue|returnValue}. */ function createSpyObj( baseName: string, methodNames: SpyObjMethodNames, propertyNames?: SpyObjPropertyNames, ): SpyObj; /** * Create an object with multiple {@link Spy}s as its members. * @since 1.3.0 * @param baseName - Base name for the spies in the object. * @param methodNames - Array of method names to create spies for, or Object whose keys will be method names and values the {@link Spy#and#returnValue|returnValue}. * @param propertyNames - Array of property names to create spies for, or Object whose keys will be propertynames and values the {@link Spy#and#returnValue|returnValue}. */ function createSpyObj(methodNames: SpyObjMethodNames, propertyNames?: SpyObjPropertyNames): any; /** * Create an object with multiple {@link Spy}s as its members. * @since 1.3.0 * @param baseName - Base name for the spies in the object. * @param methodNames - Array of method names to create spies for, or Object whose keys will be method names and values the {@link Spy#and#returnValue|returnValue}. * @param propertyNames - Array of property names to create spies for, or Object whose keys will be propertynames and values the {@link Spy#and#returnValue|returnValue}. */ function createSpyObj(methodNames: SpyObjMethodNames, propertyNames?: SpyObjPropertyNames): SpyObj; /** * Get the currently booted Jasmine Environment. * * @since 1.3.0 */ function getEnv(): Env; /** * Logs a message for use in debugging. If the spec fails, trace messages * will be included in the {@link SpecDoneEvent|result} passed to the * reporter's specDone method. * * This method should be called only when a spec (including any associated * beforeEach or afterEach functions) is running. * @since 4.0.0 * @param msg - The message to log */ function debugLog(msg: string): void; /** * Add a custom equality tester for the current scope of specs. * * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. * @since 2.0.0 * @param tester - A function which takes two arguments to compare and returns a `true` or `false` comparison result if it knows how to compare them, and `undefined` otherwise. */ function addCustomEqualityTester(equalityTester: CustomEqualityTester): void; /** * Add a custom object formatter for the current scope of specs. * Note: This is only callable from within a beforeEach, it, or beforeAll. * @since 3.6.0 * @see https://jasmine.github.io/tutorials/custom_object_formatters */ function addCustomObjectFormatter(formatter: CustomObjectFormatter): void; /** * Add custom matchers for the current scope of specs. * * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. * @since 2.0.0 * @param matchers - Keys from this object will be the new matcher names. */ function addMatchers(matchers: CustomMatcherFactories): void; /** * Add custom async matchers for the current scope of specs. * * _Note:_ This is only callable from within a {@link beforeEach}, {@link it}, or {@link beforeAll}. * @since 3.5.0 * @param matchers - Keys from this object will be the new async matcher names. */ function addAsyncMatchers(matchers: CustomAsyncMatcherFactories): void; /** * Get an {@link AsymmetricEqualityTester} that will succeed if the actual * value is a `String` that matches the `RegExp` or `String`. * @since 2.2.0 * @param expected */ function stringMatching(expected: string | RegExp): AsymmetricMatcher; /** * Get an {@link AsymmetricEqualityTester} that will succeed if the actual * value is a `String` that contains the specified `String`. * @since 3.10.0 * @param expected */ function stringContaining(expected: string): AsymmetricMatcher; interface Any extends AsymmetricMatcher { new(expectedClass: any): any; jasmineToString(prettyPrint: (value: any) => string): string; } interface AsymmetricMatcher { asymmetricMatch(other: TValue, matchersUtil?: MatchersUtil): boolean; jasmineToString?(prettyPrint: (value: any) => string): string; } // taken from TypeScript lib.core.es6.d.ts, applicable to CustomMatchers.contains() interface ArrayLike { length: number; [n: number]: T; } interface ArrayContaining extends AsymmetricMatcher { new?(sample: ArrayLike): ArrayLike; jasmineToString(prettyPrint: (value: any) => string): string; } interface ObjectContaining extends AsymmetricMatcher { new?(sample: { [K in keyof T]?: any }): { [K in keyof T]?: any }; jasmineToString?(prettyPrint: (value: any) => string): string; } interface Clock { autoTick(): void; install(): Clock; 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. */ tick(ms: number): void; mockDate(date?: Date): void; withMock(func: () => void): void; } // eslint-disable-next-line @typescript-eslint/no-invalid-void-type type CustomEqualityTester = (first: any, second: any) => boolean | void; type CustomObjectFormatter = (value: unknown) => string | undefined; interface CustomMatcher { compare(actual: T, expected: T, ...args: any[]): CustomMatcherResult; compare(actual: any, ...expected: any[]): CustomMatcherResult; negativeCompare?(actual: T, expected: T, ...args: any[]): CustomMatcherResult; negativeCompare?(actual: any, ...expected: any[]): CustomMatcherResult; } interface CustomAsyncMatcher { compare(actual: T, expected: T, ...args: any[]): PromiseLike; compare(actual: any, ...expected: any[]): PromiseLike; negativeCompare?(actual: T, expected: T, ...args: any[]): PromiseLike; negativeCompare?(actual: any, ...expected: any[]): PromiseLike; } type CustomMatcherFactory = (util: MatchersUtil) => CustomMatcher; type CustomAsyncMatcherFactory = (util: MatchersUtil) => CustomAsyncMatcher; interface CustomMatcherFactories { [name: string]: CustomMatcherFactory; } interface CustomAsyncMatcherFactories { [name: string]: CustomAsyncMatcherFactory; } interface CustomMatcherResult { pass: boolean; message?: string | undefined; } /** * @deprecated Private type that may be changed or removed in the future */ interface DiffBuilder { setRoots(actual: any, expected: any): void; recordMismatch(formatter?: (actual: any, expected: any, path?: any, prettyPrinter?: any) => string): void; withPath(pathComponent: string, block: () => void): void; getMessage(): string; } interface MatchersUtil { equals(a: any, b: any): boolean; contains( haystack: ArrayLike | string, needle: any, ): boolean; /** * @deprecated Private method that may be changed or removed in the future */ buildFailureMessage(matcherName: string, isNot: boolean, actual: any, ...expected: any[]): string; /** * Formats a value for use in matcher failure messages and similar * contexts, taking into account the current set of custom value * formatters. * @since 3.6.0 * @param value The value to pretty-print * @return The pretty-printed value */ pp(value: any): string; } interface Env { addReporter(reporter: CustomReporter): void; /** * Configures whether Jasmine should allow the same function to be spied on * more than once during the execution of a spec. By default, spying on * a function that is already a spy will cause an error. * @name Env#allowRespy * @since 2.5.0 * @param allow Whether to allow respying */ allowRespy(allow: boolean): void; clearReporters(): void; configuration(): Configuration; configure(configuration: Configuration): void; execute(runnablesToRun?: Suite[]): Promise; provideFallbackReporter(reporter: CustomReporter): void; /** * Sets a user-defined property that will be provided to reporters as * part of the properties field of SpecResult. * @since 3.6.0 */ setSpecProperty: typeof setSpecProperty; /** * Sets a user-defined property that will be provided to reporters as * part of the properties field of SuiteResult. * @since 3.6.0 */ setSuiteProperty: typeof setSuiteProperty; /** * Provides the root suite, through which all suites and specs can be * accessed. * @return the root suite * @since 2.0.0 */ topSuite(): Suite; } interface HtmlReporter { new(): any; } interface HtmlSpecFilter { new(): any; } interface Result { type: string; } interface ExpectationResult extends Result { /** * The name of the matcher that was executed for this expectation. */ matcherName: string; /** * The failure message for the expectation. */ message: string; /** * The stack trace for the failure if available. */ stack: string; /** * Whether the expectation passed or failed. */ passed: boolean; /** * Deprecated. If the expectation failed, what was the expected value. * @deprecated The expected and actual properties are deprecated and may be removed in a future release. */ expected: any; /** * Deprecated. If the expectation failed, what actual value was produced. * @deprecated The expected and actual properties are deprecated and may be removed in a future release. */ actual: any; } interface DeprecationWarning extends Result { message: string; stack: string; } interface Order { new(options: { random: boolean; seed: number | string }): any; random: boolean; seed: number | string; sort(items: T[]): T[]; } namespace errors { class ExpectationFailed extends Error { constructor(); stack: any; } } interface Matchers { /** * Expect the actual value to be `===` to the expected value. * * @param expected The expected value to compare against. * @example * expect(thing).toBe(realThing); */ toBe(expected: Expected): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBe(expected: Expected, expectationFailOutput: any): void; /** * Expect the actual value to be equal to the expected, using deep equality comparison. * @param expected Expected value. * @example * expect(bigObject).toEqual({ "foo": ['bar', 'baz'] }); */ toEqual(expected: Expected): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toEqual(expected: Expected, expectationFailOutput: any): void; /** * Expect the actual value to match a regular expression. * @param expected Value to look for in the string. * @example * expect("my string").toMatch(/string$/); * expect("other string").toMatch("her"); */ toMatch(expected: string | RegExp): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toMatch(expected: string | RegExp, expectationFailOutput: any): void; /** * {@link expect} the actual value to be defined. (Not `undefined`) * @name matchers#toBeDefined * @since 1.3.0 * @example * expect(result).toBeDefined(); */ toBeDefined(): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeDefined(expectationFailOutput: any): void; /** * {@link expect} the actual value to be `undefined`. * @since 1.3.0 * @example * expect(result).toBeUndefined(): */ toBeUndefined(): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeUndefined(expectationFailOutput: any): void; /** * {@link expect} the actual value to be `null`. * @since 1.3.0 * @example * expect(result).toBeNull(); */ toBeNull(): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeNull(expectationFailOutput: any): void; /** * {@link expect} the actual value to be `NaN` (Not a Number). * @since 1.3.0 * @example * expect(thing).toBeNaN(); */ toBeNaN(): void; /** * {@link expect} the actual value to be truthy. * @since 2.0.0 * @example * expect(thing).toBeTruthy(); */ toBeTruthy(): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeTruthy(expectationFailOutput: any): void; toBeFalsy(): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeFalsy(expectationFailOutput: any): void; toBeTrue(): void; toBeFalse(): void; /** * {@link expect} the actual (a {@link Spy}) to have been called. * @since 1.3.0 * @example * expect(mySpy).toHaveBeenCalled(); * expect(mySpy).not.toHaveBeenCalled(); */ toHaveBeenCalled(): void; /** * {@link expect} the actual value (a {@link Spy}) to have been called before another {@link Spy}. * @since 2.6.0 * @param expected - {@link Spy} that should have been called after the `actual` {@link Spy}. * @example * expect(mySpy).toHaveBeenCalledBefore(otherSpy); */ toHaveBeenCalledBefore(expected: Func): void; /** * {@link expect} the actual (a {@link Spy}) to have been called with particular arguments at least once. * @since 1.3.0 * @param params - The arguments to look for * @example * expect(mySpy).toHaveBeenCalledWith('foo', 'bar', 2); */ toHaveBeenCalledWith(...params: any[]): void; /** * {@link expect} the actual (a {@link Spy}) to have been called exactly once, and exactly with the particular arguments. * @since 3.6.0 * @param params - The arguments to look for * @example * expect(mySpy).toHaveBeenCalledOnceWith('foo', 'bar', 2); */ toHaveBeenCalledOnceWith(...params: any[]): void; /** * {@link expect} the actual (a {@link Spy}) to have been called the specified number of times. * @since 2.4.0 * @param expected - The number of invocations to look for. * @example * expect(mySpy).toHaveBeenCalledTimes(3); */ toHaveBeenCalledTimes(expected: number): void; toContain(expected: any): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toContain(expected: any, expectationFailOutput: any): void; toBeLessThan(expected: number): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeLessThan(expected: number, expectationFailOutput: any): void; toBeLessThanOrEqual(expected: number): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeLessThanOrEqual(expected: number, expectationFailOutput: any): void; toBeGreaterThan(expected: number): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeGreaterThan(expected: number, expectationFailOutput: any): void; toBeGreaterThanOrEqual(expected: number): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeGreaterThanOrEqual(expected: number, expectationFailOutput: any): void; toBeCloseTo(expected: number, precision?: any): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeCloseTo(expected: number, precision: any, expectationFailOutput: any): void; toThrow(expected?: any): void; toThrowError(message?: string | RegExp): void; toThrowError(expected?: new(...args: any[]) => Error, message?: string | RegExp): void; toThrowMatching(predicate: (thrown: any) => boolean): void; toBeNegativeInfinity(): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeNegativeInfinity(expectationFailOutput: any): void; toBePositiveInfinity(): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBePositiveInfinity(expectationFailOutput: any): void; toBeInstanceOf(expected: Constructor): void; /** * Expect the actual value to be a DOM element that has the expected class. * @since 3.0.0 * @param expected The class name to test for. * @example * var el = document.createElement('div'); * el.className = 'foo bar baz'; * expect(el).toHaveClass('bar'); */ toHaveClass(expected: string): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toHaveClass(expected: string, expectationFailOutput: any): void; /** * Expect the actual size to be equal to the expected, using array-like * length or object keys size. * @since 3.6.0 * @param expected The expected size * @example * array = [1,2]; * expect(array).toHaveSize(2); */ toHaveSize(expected: number): void; /** * {@link expect} the actual (a {@link SpyObj}) spies to have been called. * @since 4.1.0 * @example * expect(mySpyObj).toHaveSpyInteractions(); * expect(mySpyObj).not.toHaveSpyInteractions(); */ toHaveSpyInteractions(): void; /** * Add some context for an expect. * @param message Additional context to show when the matcher fails * @checkReturnValue see https://tsetse.info/check-return-value */ withContext(message: string): Matchers; /** * Invert the matcher following this expect. */ not: Matchers; } interface ArrayLikeMatchers extends Matchers> { /** * Expect the actual value to be `===` to the expected value. * * @param expected The expected value to compare against. * @example * expect(thing).toBe(realThing); */ toBe(expected: Expected> | ArrayContaining): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBe(expected: Expected> | ArrayContaining, expectationFailOutput: any): void; /** * Expect the actual value to be equal to the expected, using deep equality comparison. * @param expected Expected value. * @example * expect(bigObject).toEqual({ "foo": ['bar', 'baz'] }); */ toEqual(expected: Expected> | ArrayContaining): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toEqual(expected: Expected> | ArrayContaining, expectationFailOutput: any): void; toContain(expected: Expected): void; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toContain(expected: Expected, expectationFailOutput: any): void; /** * Add some context for an expect. * @param message Additional context to show when the matcher fails. * @checkReturnValue see https://tsetse.info/check-return-value */ withContext(message: string): ArrayLikeMatchers; /** * Invert the matcher following this expect. */ not: ArrayLikeMatchers; } type MatchableArgs = Fn extends (...args: infer P) => any ? { [K in keyof P]: Expected } : never; interface FunctionMatchers extends Matchers { /** * Expects the actual (a spy) to have been called with the particular arguments at least once * @param params The arguments to look for */ toHaveBeenCalledWith(...params: MatchableArgs): void; /** * Expects the actual (a spy) to have been called exactly once, and exactly with the particular arguments * @param params The arguments to look for */ toHaveBeenCalledOnceWith(...params: MatchableArgs): void; /** * Add some context for an expect. * @param message Additional context to show when the matcher fails. * @checkReturnValue see https://tsetse.info/check-return-value */ withContext(message: string): FunctionMatchers; /** * Invert the matcher following this expect. */ not: FunctionMatchers; } interface NothingMatcher { nothing(): void; } interface AsyncMatchers { /** * Expect a promise to be pending, i.e. the promise is neither resolved nor rejected. */ toBePending(): PromiseLike; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBePending(expectationFailOutput: any): PromiseLike; /** * Expect a promise to be resolved. */ toBeResolved(): PromiseLike; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeResolved(expectationFailOutput: any): PromiseLike; /** * Expect a promise to be rejected. */ toBeRejected(): PromiseLike; /** * @deprecated expectationFailOutput is deprecated. Use withContext instead. */ // tslint:disable-next-line unified-signatures toBeRejected(expectationFailOutput: any): PromiseLike; /** * Expect a promise to be resolved to a value equal to the expected, using deep equality comparison. * @param expected Value that the promise is expected to resolve to. */ toBeResolvedTo(expected: Expected): PromiseLike; /** * Expect a promise to be rejected with a value equal to the expected, using deep equality comparison. * @param expected Value that the promise is expected to be rejected with. */ toBeRejectedWith(expected: Expected): PromiseLike; /** * Expect a promise to be rejected with a value matched to the expected. * @param expected Error constructor the object that was thrown needs to be an instance of. If not provided, Error will be used. * @param message The message that should be set on the thrown Error. */ toBeRejectedWithError(expected?: new(...args: any[]) => Error, message?: string | RegExp): PromiseLike; /** * Expect a promise to be rejected with a value matched to the expected. * @param message The message that should be set on the thrown Error. */ toBeRejectedWithError(message?: string | RegExp): PromiseLike; /** * Add some context for an expect. * @param message Additional context to show when the matcher fails. * @checkReturnValue see https://tsetse.info/check-return-value */ withContext(message: string): AsyncMatchers; /** * Fail as soon as possible if the actual is pending. Otherwise evaluate the matcher. */ already: AsyncMatchers; /** * Invert the matcher following this expect. */ not: AsyncMatchers; } interface JasmineStartedInfo { totalSpecsDefined: number; order: Order; } interface CustomReportExpectation { matcherName: string; message: string; passed: boolean; stack: string; } interface FailedExpectation extends CustomReportExpectation { actual: string; expected: string; } interface PassedExpectation extends CustomReportExpectation {} interface DeprecatedExpectation { message: string; } interface SuiteResult { /** * The unique id of this spec. */ id: string; /** * The description passed to the {@link it} that created this spec. */ description: string; /** * The full description including all ancestors of this spec. */ fullName: string; /** * The name of the file the suite was defined in. */ filename: string; /** * The list of expectations that failed during execution of this spec. */ failedExpectations: FailedExpectation[]; /** * The list of deprecation warnings that occurred during execution this spec. */ deprecationWarnings: DeprecatedExpectation[]; /** * Once the spec has completed, this string represents the pass/fail status of this spec. */ status: string; /** * The time in ms used by the spec execution, including any before/afterEach. */ duration: number | null; /** * User-supplied properties, if any, that were set using {@link Env.setSuiteProperty} */ properties: { [key: string]: unknown } | null; } interface SpecResult extends SuiteResult { /** * The list of expectations that passed during execution of this spec. */ passedExpectations: PassedExpectation[]; /** * If the spec is pending, this will be the reason. */ pendingReason: string; debugLogs: DebugLogEntry[] | null; /** * User-supplied properties, if any, that were set using {@link Env.setSpecProperty} */ properties: { [key: string]: unknown } | null; } interface DebugLogEntry { message: String; timestamp: number; } interface JasmineDoneInfo { overallStatus: string; totalTime: number; incompleteReason: string; order: Order; failedExpectations: ExpectationResult[]; deprecationWarnings: ExpectationResult[]; } /** @deprecated use JasmineStartedInfo instead */ type SuiteInfo = JasmineStartedInfo; /** @deprecated use SuiteResult or SpecResult instead */ type CustomReporterResult = SuiteResult & SpecResult; /** @deprecated use JasmineDoneInfo instead */ type RunDetails = JasmineDoneInfo; interface CustomReporter { jasmineStarted?(suiteInfo: JasmineStartedInfo, done?: () => void): void | Promise; suiteStarted?(result: SuiteResult, done?: () => void): void | Promise; specStarted?(result: SpecResult, done?: () => void): void | Promise; specDone?(result: SpecResult, done?: () => void): void | Promise; suiteDone?(result: SuiteResult, done?: () => void): void | Promise; jasmineDone?(runDetails: JasmineDoneInfo, done?: () => void): void | Promise; } interface SpecFilter { /** * A function that takes a spec and returns true if it should be executed or false if it should be skipped. * @param spec The spec that the filter is being applied to */ (spec: Spec): boolean; } /** @deprecated Please use `SpecFilter` instead of `SpecFunction`. */ type SpecFunction = (spec?: Spec) => void; interface Spec { new(attrs: any): any; readonly id: string; env: Env; readonly description: string; getFullName(): string; } interface Suite extends Spec { parentSuite: Suite; children: Array; } interface Spy { (...params: Parameters): ReturnType; and: SpyAnd; calls: Calls; withArgs(...args: MatchableArgs): Spy; } type SpyObj = & T & { [K in keyof T]: T[K] extends Func ? T[K] & Spy : T[K]; }; /** * Determines whether the provided function is a Jasmine spy. * @since 2.0.0 * @param putativeSpy The function to check. */ function isSpy(putativeSpy: Func): putativeSpy is Spy; /** * It's like SpyObj, but doesn't verify argument/return types for functions. * Useful if TS cannot correctly infer type for complex objects. */ type NonTypedSpyObj = SpyObj<{ [K in keyof T]: T[K] extends Func ? Func : T[K] }>; /** * Obtains the promised type that a promise-returning function resolves to. */ type PromisedResolveType = T extends PromiseLike ? TResult : never; /** * Obtains the type that a promise-returning function can be rejected with. * This is so we can use .and.rejectWith() only for functions that return a promise. */ type PromisedRejectType = T extends PromiseLike ? any : never; interface SpyAnd { identity: string; /** 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. */ returnValue(val: ReturnType): 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. */ returnValues(...values: Array>): Spy; /** By chaining the spy with and.callFake, all calls to the spy will delegate to the supplied function. */ callFake(fn: Fn): Spy; /** Tell the spy to return a promise resolving to the specified value when invoked. */ resolveTo(val?: PromisedResolveType>): Spy; /** Tell the spy to return a promise rejecting with the specified value when invoked. */ rejectWith(val?: PromisedRejectType>): Spy; /** By chaining the spy with and.throwError, all calls to the spy will throw the specified value. */ throwError(msg: string | Error): Spy; /** When a calling strategy is used for a spy, the original stubbing behavior can be returned at any time with and.stub. */ stub(): Spy; } 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. */ any(): boolean; /** 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 */ argsFor(index: number): Parameters; /** By chaining the spy with calls.allArgs(), will return the arguments to all calls */ allArgs(): ReadonlyArray>; /** By chaining the spy with calls.all(), will return the context (the this) and arguments passed all calls */ all(): ReadonlyArray>; /** 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 */ first(): CallInfo; /** By chaining the spy with calls.reset(), will clears all tracking for a spy */ reset(): void; /** Set this spy to do a shallow clone of arguments passed to each invocation. */ saveArgumentsByValue(): void; /** Get the "this" object that was passed to a specific invocation of this spy. */ thisFor(index: number): ThisType; } interface CallInfo { /** The context (the this) for the call */ object: ThisType; /** All arguments passed to the call */ args: Parameters; /** The return value of the call */ returnValue: ReturnType; } interface Util { inherit(childClass: Function, parentClass: Function): any; formatException(e: any): any; htmlEscape(str: string): string; argsToArray(args: any): any; extend(destination: any, source: any): any; } interface JsApiReporter extends CustomReporter { new(): any; started: boolean; finished: boolean; runDetails: JasmineDoneInfo; status(): string; suiteResults(index: number, length: number): SuiteResult[]; specResults(index: number, length: number): SpecResult[]; suites(): { [id: string]: SuiteResult }; specs(): SpecResult[]; executionTime(): number; } interface Jasmine { Spec: Spec; clock: Clock; util: Util; } var HtmlReporter: HtmlReporter; var HtmlSpecFilter: HtmlSpecFilter; /** * Default number of milliseconds Jasmine will wait for an asynchronous spec to complete. */ var DEFAULT_TIMEOUT_INTERVAL: number; /** * Maximum number of array elements to display when pretty printing objects. * This will also limit the number of keys and values displayed for an object. * Elements past this number will be ellipised. */ var MAX_PRETTY_PRINT_ARRAY_LENGTH: number; /** * Maximum number of characters to display when pretty printing objects. * Characters past this number will be ellipised. */ var MAX_PRETTY_PRINT_CHARS: number; /** * Maximum object depth the pretty printer will print to. * Set this to a lower value to speed up pretty printing if you have large objects. */ var MAX_PRETTY_PRINT_DEPTH: number; var version: string; interface JasmineOptions { /** * The path to the project's base directory. This can be absolute or relative * to the current working directory. If it isn't specified, the current working * directory will be used. */ projectBaseDir?: string; } interface JasmineConfig { /** * Whether to fail specs that contain no expectations. * @default false */ failSpecWithNoExpectations?: boolean; /** * An array of helper file paths or globs that match helper files. Each path or * glob will be evaluated relative to the spec directory. Helpers are loaded before specs. */ helpers?: string[]; /** * Specifies how to load files with names ending in .js. Valid values are * "require" and "import". "import" should be safe in all cases, and is * required if your project contains ES modules with filenames ending in .js. * @default "require" */ jsLoader?: "require" | "import"; /** * Whether to run specs in a random order. */ random?: boolean; /** * An array of module names to load via require() at the start of execution. */ requires?: string[]; /** * The directory that spec files are contained in, relative to the project base directory. */ spec_dir?: string; /** * An array of spec file paths or globs that match helper files. Each path * or glob will be evaluated relative to the spec directory. */ spec_files?: string[]; /** * Whether to stop suite execution on the first spec failure. */ stopOnSpecFailure?: boolean; /** * Whether to stop each spec on the first expectation failure. */ stopSpecOnExpectationFailure?: boolean; } interface DefaultReporterOptions { timer?: any; print?: (...args: any[]) => void; showColors?: boolean; jasmineCorePath?: string; } } declare module "jasmine" { class jasmine { jasmine: jasmine.Jasmine; env: jasmine.Env; /** * @deprecated Private property that may be changed or removed in the future */ reportersCount: number; /** * @deprecated Private property that may be changed or removed in the future */ reporter: jasmine.CustomReporter; /** * @deprecated Private property that may be changed or removed in the future */ showingColors: boolean; /** * @deprecated Private property that may be changed or removed in the future */ projectBaseDir: string; /** * @deprecated Private property that may be changed or removed in the future */ specDir: string; /** * @deprecated Private property that may be changed or removed in the future */ specFiles: string[]; /** * @deprecated Private property that may be changed or removed in the future */ helperFiles: string[]; /** * @deprecated Private property that may be changed or removed in the future */ requires: string[]; /** * @deprecated Private property that may be changed or removed in the future */ defaultReporterConfigured: boolean; constructor(options?: jasmine.JasmineOptions); addMatchers(matchers: jasmine.CustomMatcherFactories): void; /** * Add a custom reporter to the Jasmine environment. */ addReporter(reporter: jasmine.CustomReporter): void; /** * Adds a spec file to the list that will be loaded when the suite is executed. */ addSpecFile(filePath: string): void; addMatchingSpecFiles(patterns: string[]): void; addHelperFile(filePath: string): void; addMatchingHelperFiles(patterns: string[]): void; /** * @deprecated Private method that may be changed or removed in the future */ addRequires(files: string[]): void; /** * Configure the default reporter. */ configureDefaultReporter(options: jasmine.DefaultReporterOptions): void; execute(files?: string[], filterString?: string): Promise; exitOnCompletion: boolean; loadConfig(config: jasmine.JasmineConfig): void; loadConfigFile(configFilePath?: string): void; /** * @deprecated Private method that may be changed or removed in the future */ loadHelpers(): Promise; /** * @deprecated Private method that may be changed or removed in the future */ loadSpecs(): Promise; /** * @deprecated Private method that may be changed or removed in the future */ loadRequires(): void; /** * Provide a fallback reporter if no other reporters have been specified. */ provideFallbackReporter(reporter: jasmine.CustomReporter): void; /** * Clears all registered reporters. */ clearReporters(): void; /** * Sets whether to randomize the order of specs. */ randomizeTests(value: boolean): void; /** * Sets the random seed. */ seed(value: number): void; /** * Sets whether to show colors in the console reporter. */ showColors(value: boolean): void; stopSpecOnExpectationFailure(value: boolean): void; stopOnSpecFailure(value: boolean): void; static ConsoleReporter(): any; /** * The version of jasmine-core in use */ coreVersion(): string; } export = jasmine; }