forked from jestjs/jest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.ts
104 lines (91 loc) 路 2.59 KB
/
types.ts
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/**
* 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 {Config} from '@jest/types';
import * as jestMatcherUtils from 'jest-matcher-utils';
export type SyncExpectationResult = {
pass: boolean;
message: () => string;
};
export type AsyncExpectationResult = Promise<SyncExpectationResult>;
export type ExpectationResult = SyncExpectationResult | AsyncExpectationResult;
export type RawMatcherFn = (
expected: any,
actual: any,
options?: any,
) => ExpectationResult;
export type ThrowingMatcherFn = (actual: any) => void;
export type PromiseMatcherFn = (actual: any) => Promise<void>;
export type Tester = (a: any, b: any) => boolean | undefined;
export type MatcherState = {
assertionCalls: number;
currentTestName?: string;
dontThrow?: () => void;
error?: Error;
equals: (
a: unknown,
b: unknown,
customTesters?: Array<Tester>,
strictCheck?: boolean,
) => boolean;
expand?: boolean;
expectedAssertionsNumber?: number;
isExpectingAssertions?: boolean;
isNot: boolean;
promise: string;
snapshotState: any;
suppressedErrors: Array<Error>;
testPath?: Config.Path;
utils: typeof jestMatcherUtils & {
iterableEquality: Tester;
subsetEquality: Tester;
};
};
export type AsymmetricMatcher = Object;
export type MatchersObject = {[id: string]: RawMatcherFn};
export type Expect = {
(expected: any): ExpectationObject;
addSnapshotSerializer(arg0: any): void;
assertions(arg0: number): void;
extend(arg0: any): void;
extractExpectedAssertionsErrors: () => Array<{
actual: string | number;
error: Error;
expected: string;
}>;
getState(): MatcherState;
hasAssertions(): void;
setState(arg0: any): void;
any(expectedObject: any): AsymmetricMatcher;
anything(): AsymmetricMatcher;
arrayContaining(sample: Array<any>): AsymmetricMatcher;
objectContaining(sample: Object): AsymmetricMatcher;
stringContaining(expected: string): AsymmetricMatcher;
stringMatching(expected: string | RegExp): AsymmetricMatcher;
[id: string]: AsymmetricMatcher;
not: {[id: string]: AsymmetricMatcher};
};
type resolvesFn = {
[id: string]: PromiseMatcherFn;
} & {
not: {[id: string]: PromiseMatcherFn};
};
type rejectsFn = {
[id: string]: PromiseMatcherFn;
} & {
not: {[id: string]: PromiseMatcherFn};
};
type notFn = {
[id: string]: ThrowingMatcherFn;
};
export type ExpectationObject = {
[id: string]: ThrowingMatcherFn;
} & {
resolves: resolvesFn;
rejects: rejectsFn;
not: notFn;
};