1 | # Installation
|
2 | > `npm install --save @types/empower`
|
3 |
|
4 | # Summary
|
5 | This package contains type definitions for empower (https://github.com/power-assert-js/empower).
|
6 |
|
7 | # Details
|
8 | Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/empower.
|
9 | ## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/empower/index.d.ts)
|
10 | ````ts
|
11 | import { Options as CoreOptions } from "empower-core";
|
12 | import { Formatter } from "power-assert-formatter";
|
13 |
|
14 | /**
|
15 | * Enhances Power Assert feature to assert function/object.
|
16 | *
|
17 | * @param originalAssert An instance of standard `assert` function or any assert-like object to enhance.
|
18 | * @param formatter A formatter function created by power-assert-formatter.
|
19 | * @param options Configuration options. If not passed, default options will be used.
|
20 | * @return Enhanced assert function/object.
|
21 | */
|
22 | declare function empower<T>(originalAssert: T, formatter: Formatter, options?: empower.Options): T;
|
23 |
|
24 | declare namespace empower {
|
25 | // The omitted options can be provided, but they will be always overridden.
|
26 | type Options = Omit<CoreOptions, "modifyMessageBeforeAssert" | "onError"> & {
|
27 | /**
|
28 | * If truthy, modify message property of `AssertionError` on rethrow.
|
29 | *
|
30 | * @default false
|
31 | */
|
32 | modifyMessageOnRethrow?: boolean | undefined;
|
33 | /**
|
34 | * If truthy, add `powerAssertContext` property to `AssertionError` on rethrow.
|
35 | *
|
36 | * @default false
|
37 | */
|
38 | saveContextOnRethrow?: boolean | undefined;
|
39 | };
|
40 |
|
41 | /**
|
42 | * Returns default options object for `empower` function.
|
43 | */
|
44 | function defaultOptions(): Required<Options>;
|
45 | }
|
46 |
|
47 | export = empower;
|
48 |
|
49 | ````
|
50 |
|
51 | ### Additional Details
|
52 | * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
|
53 | * Dependencies: [@types/empower-core](https://npmjs.com/package/@types/empower-core), [@types/power-assert-formatter](https://npmjs.com/package/@types/power-assert-formatter)
|
54 |
|
55 | # Credits
|
56 | These definitions were written by [vvakame](https://github.com/vvakame).
|
57 |
|
\ | No newline at end of file |