Package Exports

gulp-esdoc-stream

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (gulp-esdoc-stream) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

gulp-esdoc-stream

ESDoc stream for gulp.

Usage

const esdoc = require( 'gulp-esdoc-stream' );

Basic, fast usage. Will pipe every file through ESDoc. Only the paths are necessary.

gulp.task( "default", function() {
    return gulp.src( "src/**/*.js", { read: false } )
        .pipe( esdoc( 'docs' ) )
    ;
});

Basic, slower usage. Will output the documentation on the docs folder, and keep on piping the js files.

gulp.task( "default", function() {
    return gulp.src( "src/**/*.js" )
        .pipe( esdoc( 'docs' ) )
        .pipe( gulp.dest( "build" ) )
    ;
});

Pipes the generated files from the documentation.

gulp.task( "default", function() {
    return gulp.src( "src/**/*.js", { read: false } )
        .pipe( esdoc() )
        .pipe( gulp.dest( "docs" ) )
    ;
});