gulp-typedoc-extractor

gulp-typedoc-extractor

A post processor to extract a module from gulp-typedoc json output.

Usage

First, install gulp-typedoc-extractor as a development dependency:

npm install --save-dev gulp-typedoc-extractor

Then, add it to your gulpfile.js:

Extract Module

var extractModule = require('gulp-typedoc-extractor');

gulp.task('extract-module', function(){
  gulp.src(['dest/full-api.json'])
    .pipe(extractModule('aurelia-framework'))
    .pipe(gulp.dest('dest/api.json'));
});

API

gulp-typedoc-extractor is called with a module name.

extractModule(string)

string

Type: String

The module to extract from the json generated by gulp-typedoc.