@microsoft/api-extractor

Generate API Report

This feature allows you to generate an API report for your TypeScript library. The report includes details about the public API surface, which can be used for documentation and compatibility checks.

const { Extractor, ExtractorConfig } = require('@microsoft/api-extractor');
const path = require('path');

const configPath = path.join(__dirname, 'api-extractor.json');
const extractorConfig = ExtractorConfig.loadFileAndPrepare(configPath);
const extractorResult = Extractor.invoke(extractorConfig, {
  localBuild: true,
  showVerboseMessages: true
});

if (extractorResult.succeeded) {
  console.log('API Extractor completed successfully');
} else {
  console.error(`API Extractor completed with ${extractorResult.errorCount} errors`);
}

Generate API Documentation

This feature allows you to generate API documentation from the TypeScript library. The documentation is based on the public API surface and can be used for reference and development purposes.

const { Extractor, ExtractorConfig } = require('@microsoft/api-extractor');
const path = require('path');

const configPath = path.join(__dirname, 'api-extractor.json');
const extractorConfig = ExtractorConfig.loadFileAndPrepare(configPath);
const extractorResult = Extractor.invoke(extractorConfig, {
  localBuild: true,
  showVerboseMessages: true
});

if (extractorResult.succeeded) {
  console.log('API documentation generated successfully');
} else {
  console.error(`API documentation generation failed with ${extractorResult.errorCount} errors`);
}

Ensure API Compatibility

This feature allows you to ensure API compatibility by comparing the current API surface with a previously generated API report. It helps in maintaining backward compatibility and avoiding breaking changes.

const { Extractor, ExtractorConfig } = require('@microsoft/api-extractor');
const path = require('path');

const configPath = path.join(__dirname, 'api-extractor.json');
const extractorConfig = ExtractorConfig.loadFileAndPrepare(configPath);
const extractorResult = Extractor.invoke(extractorConfig, {
  localBuild: true,
  showVerboseMessages: true
});

if (extractorResult.succeeded) {
  console.log('API compatibility check passed');
} else {
  console.error(`API compatibility check failed with ${extractorResult.errorCount} errors`);
}