本文整理汇总了TypeScript中@microsoft/api-extractor.ExtractorConfig类的典型用法代码示例。如果您正苦于以下问题：TypeScript ExtractorConfig类的具体用法？TypeScript ExtractorConfig怎么用？TypeScript ExtractorConfig使用的例子？那么, 这里精选的类代码示例或许可以为您提供帮助。
在下文中一共展示了ExtractorConfig类的2个代码示例，这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞，您的评价将有助于系统推荐出更棒的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);
};示例2:
const apiExtractorConfig = (folder: string): ExtractorConfig => {
const config: IConfigFile = {
compiler: {
tsconfigFilePath: '<projectFolder>/tsconfig.json',
},
projectFolder: path.resolve('./'),
mainEntryPointFilePath: `target/types/${folder}/index.d.ts`,
apiReport: {
enabled: true,
reportFileName: `${folder}.api.md`,
reportFolder: `<projectFolder>/src/core/${folder}/`,
reportTempFolder: `<projectFolder>/build/${folder}/`,
},
docModel: {
enabled: true,
apiJsonFilePath: `./build/${folder}/${folder}.api.json`,
},
tsdocMetadata: {
enabled: false,
},
messages: {
extractorMessageReporting: {
default: {
logLevel: 'warning' as ExtractorLogLevel.Warning,
addToApiReportFile: true,
},
'ae-internal-missing-underscore': {
logLevel: 'none' as ExtractorLogLevel.None,
addToApiReportFile: false,
},
},
},
};
const con = ExtractorConfig.prepare({
configObject: config,
configObjectFullPath: undefined,
packageJsonFullPath: path.resolve('package.json'),
});
return con;
};