Installation

npm install --save @types/license-checker-webpack-plugin

Summary

This package contains type definitions for license-checker-webpack-plugin (https://github.com/Microsoft/license-checker-webpack-plugin#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/license-checker-webpack-plugin.

index.d.ts

1import { Compiler, WebpackPluginInstance } from "webpack";
2
3declare class LicenseCheckerWebpackPlugin implements WebpackPluginInstance {
4    constructor(options?: Partial<LicenseCheckerWebpackPlugin.Options>);
5    apply(compiler: Compiler): void;
6}
7
8declare namespace LicenseCheckerWebpackPlugin {
9    interface Dependency {
10        name: string;
11        version: string;
12        repository?: string;
13        author?: string;
14        licenseName: string;
15        licenseText?: string;
16    }
17
18    interface OutputWriterArgs {
19        dependencies: Dependency[];
20    }
21
22    type OutputWriter = (args: OutputWriterArgs) => string;
23
24    interface Options {
25        /**
26         * Regular expression that matches the file paths of dependencies to check.
27         */
28        filter: RegExp;
29
30        /**
31         * SPDX expression with allowed licenses.
32         *
33         * @default "(Apache-2.0 OR BSD-2-Clause OR BSD-3-Clause OR MIT)"
34         */
35        allow: string;
36
37        /**
38         * Array of dependencies to ignore, in the format `["<dependency name>@<version range>"]`.
39         * For example, `["assignment@^2.0.0"]`.
40         *
41         * @default []
42         */
43        ignore: string[];
44
45        /**
46         * Object of dependencies to override, in the format `{"<dependency name>@<version range>": { ... }}`.
47         * For example, `{"assignment@^2.0.0": { licenseName: "MIT" }}`.
48         *
49         * @default {}
50         */
51        override: Record<string, Partial<Dependency>>;
52
53        /**
54         * Whether to emit errors instead of warnings.
55         *
56         * @default false
57         */
58        emitError: boolean;
59
60        /**
61         * Path to a `.ejs` template, or function that will generate the contents
62         * of the third-party notices file.
63         */
64        outputWriter: string | OutputWriter;
65
66        /**
67         * Name of the third-party notices file with all licensing information.
68         *
69         * @default "ThirdPartyNotices.txt"
70         */
71        outputFilename: string;
72    }
73}
74
75export = LicenseCheckerWebpackPlugin;
76

Additional Details

• Last updated: Tue, 07 Nov 2023 09:09:38 GMT
• Dependencies: @types/webpack

Credits

These definitions were written by .