本文整理匯總了TypeScript中@microsoft/api-extractor.Extractor.invoke方法的典型用法代碼示例。如果您正苦於以下問題:TypeScript Extractor.invoke方法的具體用法?TypeScript Extractor.invoke怎麽用?TypeScript Extractor.invoke使用的例子?那麽, 這裏精選的方法代碼示例或許可以為您提供幫助。您也可以進一步了解該方法所在類@microsoft/api-extractor.Extractor
的用法示例。
在下文中一共展示了Extractor.invoke方法的1個代碼示例,這些例子默認根據受歡迎程度排序。您可以為喜歡或者感覺有用的代碼點讚,您的評價將有助於係統推薦出更棒的TypeScript代碼示例。
示例1: apiExtractorConfig
const runApiExtractor = (
log: ToolingLog,
folder: string,
acceptChanges: boolean = false
): ExtractorResult => {
const config = apiExtractorConfig(folder);
const options = {
// Indicates that API Extractor is running as part of a local build,
// e.g. on developer's machine. For example, if the *.api.ts output file
// has differences, it will be automatically overwritten for a
// local build, whereas this should report an error for a production build.
localBuild: acceptChanges,
messageCallback: (message: ExtractorMessage) => {
if (message.messageId === 'console-api-report-not-copied') {
// ConsoleMessageId.ApiReportNotCopied
log.warning(`You have changed the signature of the ${folder} Core API`);
log.warning(
'To accept these changes run `node scripts/check_core_api_changes.js --accept` and then:\n' +
"\t 1. Commit the updated documentation and API review file '" +
config.reportFilePath +
"' \n" +
"\t 2. Describe the change in your PR including whether it's a major, minor or patch"
);
message.handled = true;
} else if (message.messageId === 'console-api-report-copied') {
// ConsoleMessageId.ApiReportCopied
log.warning(`You have changed the signature of the ${folder} Core API`);
log.warning(
"Please commit the updated API documentation and the review file in '" +
config.reportFilePath
);
message.handled = true;
} else if (message.messageId === 'console-api-report-unchanged') {
// ConsoleMessageId.ApiReportUnchanged
log.info(`Core ${folder} API: no changes detected â`);
message.handled = true;
}
},
};
return Extractor.invoke(config, options);
};