UNPKG

2.11 kBTypeScriptView Raw
1import { RunDetails } from '../reporter/RunDetails';
2/**
3 * Format output of {@link check} using the default error reporting of {@link assert}
4 *
5 * Produce a string containing the formated error in case of failed run,
6 * undefined otherwise.
7 *
8 * @remarks Since 1.25.0
9 * @public
10 */
11declare function defaultReportMessage<Ts>(out: RunDetails<Ts> & {
12 failed: false;
13}): undefined;
14/**
15 * Format output of {@link check} using the default error reporting of {@link assert}
16 *
17 * Produce a string containing the formated error in case of failed run,
18 * undefined otherwise.
19 *
20 * @remarks Since 1.25.0
21 * @public
22 */
23declare function defaultReportMessage<Ts>(out: RunDetails<Ts> & {
24 failed: true;
25}): string;
26/**
27 * Format output of {@link check} using the default error reporting of {@link assert}
28 *
29 * Produce a string containing the formated error in case of failed run,
30 * undefined otherwise.
31 *
32 * @remarks Since 1.25.0
33 * @public
34 */
35declare function defaultReportMessage<Ts>(out: RunDetails<Ts>): string | undefined;
36/**
37 * Format output of {@link check} using the default error reporting of {@link assert}
38 *
39 * Produce a string containing the formated error in case of failed run,
40 * undefined otherwise.
41 *
42 * @remarks Since 2.17.0
43 * @public
44 */
45declare function asyncDefaultReportMessage<Ts>(out: RunDetails<Ts> & {
46 failed: false;
47}): Promise<undefined>;
48/**
49 * Format output of {@link check} using the default error reporting of {@link assert}
50 *
51 * Produce a string containing the formated error in case of failed run,
52 * undefined otherwise.
53 *
54 * @remarks Since 2.17.0
55 * @public
56 */
57declare function asyncDefaultReportMessage<Ts>(out: RunDetails<Ts> & {
58 failed: true;
59}): Promise<string>;
60/**
61 * Format output of {@link check} using the default error reporting of {@link assert}
62 *
63 * Produce a string containing the formated error in case of failed run,
64 * undefined otherwise.
65 *
66 * @remarks Since 2.17.0
67 * @public
68 */
69declare function asyncDefaultReportMessage<Ts>(out: RunDetails<Ts>): Promise<string | undefined>;
70export { defaultReportMessage, asyncDefaultReportMessage };