aboutsummaryrefslogtreecommitdiff
path: root/node_modules/jest-jasmine2/build/jasmine/Spec.d.ts
blob: e6ba7ceff1af6c48d43d343601725b857a0c3a05 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/**
 * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */
import type { FailedAssertion, Milliseconds, Status } from '@jest/test-result';
import type { Config } from '@jest/types';
import ExpectationFailed from '../ExpectationFailed';
import expectationResultFactory, { Options as ExpectationResultFactoryOptions } from '../expectationResultFactory';
import type { QueueableFn, default as queueRunner } from '../queueRunner';
import type { AssertionErrorWithStack } from '../types';
export declare type Attributes = {
    id: string;
    resultCallback: (result: Spec['result']) => void;
    description: string;
    throwOnExpectationFailure: unknown;
    getTestPath: () => Config.Path;
    queueableFn: QueueableFn;
    beforeAndAfterFns: () => {
        befores: Array<QueueableFn>;
        afters: Array<QueueableFn>;
    };
    userContext: () => unknown;
    onStart: (context: Spec) => void;
    getSpecName: (spec: Spec) => string;
    queueRunnerFactory: typeof queueRunner;
};
export declare type SpecResult = {
    id: string;
    description: string;
    fullName: string;
    duration?: Milliseconds;
    failedExpectations: Array<FailedAssertion>;
    testPath: Config.Path;
    passedExpectations: Array<ReturnType<typeof expectationResultFactory>>;
    pendingReason: string;
    status: Status;
    __callsite?: {
        getColumnNumber: () => number;
        getLineNumber: () => number;
    };
};
export default class Spec {
    id: string;
    description: string;
    resultCallback: (result: SpecResult) => void;
    queueableFn: QueueableFn;
    beforeAndAfterFns: () => {
        befores: Array<QueueableFn>;
        afters: Array<QueueableFn>;
    };
    userContext: () => unknown;
    onStart: (spec: Spec) => void;
    getSpecName: (spec: Spec) => string;
    queueRunnerFactory: typeof queueRunner;
    throwOnExpectationFailure: boolean;
    initError: Error;
    result: SpecResult;
    disabled?: boolean;
    currentRun?: ReturnType<typeof queueRunner>;
    markedTodo?: boolean;
    markedPending?: boolean;
    expand?: boolean;
    static pendingSpecExceptionMessage: string;
    static isPendingSpecException(e: Error): boolean;
    constructor(attrs: Attributes);
    addExpectationResult(passed: boolean, data: ExpectationResultFactoryOptions, isError?: boolean): void;
    execute(onComplete?: () => void, enabled?: boolean): void;
    cancel(): void;
    onException(error: ExpectationFailed | AssertionErrorWithStack): void;
    disable(): void;
    pend(message?: string): void;
    todo(): void;
    getResult(): SpecResult;
    status(enabled?: boolean): "todo" | "passed" | "failed" | "pending" | "disabled";
    isExecutable(): boolean;
    getFullName(): string;
    isAssertionError(error: Error): boolean;
}