UNPKG

1.97 kBMarkdownView Raw
1# Installation
2> `npm install --save @types/istanbul`
3
4# Summary
5This package contains type definitions for istanbul (https://github.com/gotwarlost/istanbul).
6
7# Details
8Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/istanbul.
9## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/istanbul/index.d.ts)
10````ts
11declare namespace istanbul {
12 interface Istanbul {
13 new(options?: any): Istanbul;
14 Collector: Collector;
15 config: Config;
16 ContentWriter: ContentWriter;
17 FileWriter: FileWriter;
18 hook: Hook;
19 Instrumenter: Instrumenter;
20 Report: Report;
21 Reporter: Reporter;
22 Store: Store;
23 utils: ObjectUtils;
24 VERSION: string;
25 Writer: Writer;
26 }
27
28 interface Collector {
29 new(options?: any): Collector;
30 add(coverage: any, testName?: string): void;
31 getFinalCoverage(): any;
32 }
33
34 interface Config {
35 }
36
37 interface ContentWriter {
38 }
39
40 interface FileWriter {
41 }
42
43 interface Hook {
44 }
45
46 interface Instrumenter {
47 new(options?: any): Instrumenter;
48 instrumentSync(code: string, filename: string): string;
49 }
50
51 interface Report {
52 }
53
54 interface Configuration {
55 new(obj: any, overrides: any): Configuration;
56 }
57
58 interface Reporter {
59 new(cfg?: Configuration, dir?: string): Reporter;
60 add(fmt: string): void;
61 addAll(fmts: string[]): void;
62 write(collector: Collector, sync: boolean, callback: Function): void;
63 }
64
65 interface Store {
66 }
67
68 interface ObjectUtils {
69 }
70
71 interface Writer {
72 }
73}
74
75declare var istanbul: istanbul.Istanbul;
76
77export = istanbul;
78
79````
80
81### Additional Details
82 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
83 * Dependencies: none
84
85# Credits
86These definitions were written by [Tanguy Krotoff](https://github.com/tkrotoff).
87
\No newline at end of file