@types/gulp-istanbul
Version:
TypeScript definitions for gulp-istanbul
79 lines (64 loc) • 2.54 kB
Markdown
# Installation
> `npm install --save @types/gulp-istanbul`
# Summary
This package contains type definitions for gulp-istanbul (https://github.com/SBoudrias/gulp-istanbul).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-istanbul.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gulp-istanbul/index.d.ts)
````ts
/// <reference types="node"/>
declare function GulpIstanbul(opts?: GulpIstanbul.Options): NodeJS.ReadWriteStream;
declare namespace GulpIstanbul {
export function hookRequire(): NodeJS.ReadWriteStream;
export function summarizeCoverage(opts?: { coverageVariable?: string | undefined }): Coverage;
export function writeReports(opts?: ReportOptions): NodeJS.ReadWriteStream;
export function enforceThresholds(opts?: ThresholdOptions): NodeJS.ReadWriteStream;
interface Options {
coverageVariable?: string | undefined;
includeUntested?: boolean | undefined;
embedSource?: boolean | undefined;
preserveComments?: boolean | undefined;
noCompact?: boolean | undefined;
noAutoWrap?: boolean | undefined;
codeGenerationOptions?: Object | undefined;
debug?: boolean | undefined;
walkDebug?: boolean | undefined;
}
interface Coverage {
lines: CoverageStats;
statements: CoverageStats;
functions: CoverageStats;
branches: CoverageStats;
}
interface CoverageStats {
total: number;
covered: number;
skipped: number;
pct: number;
}
interface ReportOptions {
dir?: string | undefined;
reporters?: string[] | undefined;
reportOpts?: { dir?: string | undefined } | undefined;
coverageVariable?: string | undefined;
}
interface ThresholdOptions {
coverageVariable?: string | undefined;
thresholds?:
| { global?: CoverageOptions | number | undefined; each?: CoverageOptions | number | undefined }
| undefined;
}
interface CoverageOptions {
lines?: number | undefined;
statements?: number | undefined;
functions?: number | undefined;
branches?: number | undefined;
}
}
export = GulpIstanbul;
````
### Additional Details
* Last updated: Tue, 07 Nov 2023 03:09:37 GMT
* Dependencies: [@types/node](https://npmjs.com/package/@types/node)
# Credits
These definitions were written by [Asana](https://asana.com).