Skip to content

Commit 5467736

Browse files
🤖 Merge PR DefinitelyTyped#73012 Allow OutputWriter to return promise in license-checker-webpack-plugin by @bawjensen
Co-authored-by: Bryan Jensen <[email protected]>
1 parent 04643d1 commit 5467736

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

‎types/license-checker-webpack-plugin/index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ declare namespace LicenseCheckerWebpackPlugin {
1919
dependencies: Dependency[];
2020
}
2121

22-
type OutputWriter = (args: OutputWriterArgs) => string;
22+
type OutputWriter = (args: OutputWriterArgs) => string | Promise<string>;
2323

2424
interface Options {
2525
/**

‎types/license-checker-webpack-plugin/license-checker-webpack-plugin-tests.ts‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,28 @@ new LicenseCheckerWebpackPlugin({
1111
"[email protected]": { licenseName: "MIT" },
1212
},
1313
emitError: true,
14+
// $ExpectType string
1415
outputWriter: path.resolve(__dirname, "customTemplate.ejs"),
1516
outputFilename: "ThirdPartyNotices.txt",
1617
});
1718

1819
// $ExpectType LicenseCheckerWebpackPlugin
1920
new LicenseCheckerWebpackPlugin({
2021
filter: /.*/,
22+
// $ExpectType ({ dependencies }: OutputWriterArgs) => string
2123
outputWriter: ({ dependencies }) => {
2224
dependencies; // $ExpectType Dependency[]
2325
return dependencies.map(d => `${d.name} - v${d.version} - ${d.author}\n${d.licenseName}`).join("\n");
2426
},
2527
});
2628

29+
// $ExpectType LicenseCheckerWebpackPlugin
30+
new LicenseCheckerWebpackPlugin({
31+
// $ExpectType ({ dependencies }: OutputWriterArgs) => Promise<string>
32+
outputWriter: async ({ dependencies }) => {
33+
return dependencies.map(d => d.name).join("\n");
34+
},
35+
});
36+
2737
// $ExpectType LicenseCheckerWebpackPlugin
2838
new LicenseCheckerWebpackPlugin();

0 commit comments

Comments
 (0)