@gulp-utils/gulp-core-build-api-extractor v1.0.0

@gulp-utils/gulp-core-build-api-extractor

gulp-core-build-api-extractor is a gulp-core-build subtask which introduces the ability to generate documentation, using api-extractor.

Tasks

ApiExtractorTask

Description

This task invokes api-extractor on a package, using a consumer-specified api-extractor.json.

Usage

const {apiExtractor} = require("@gulp-utils/gulp-core-build-api-extractor");
const {tsc} = require("@gulp-utils/gulp-core-build-tsc");
const {initialize, serial, task} = require("@microsoft/gulp-core-build");

apiExtractor.setConfig({
  configPath: "./config/api-extractor.json"
});

task("default", serial(tsc, apiExtractor));

initialize(require("gulp"));

Config

interface IApiExtractorTaskConfig {
  config?: ExtractorConfig;
  configPath?: string;
  options?: IExtractorInvokeOptions;
}