jsduck

jsduck

This is a Node.js-compatible wrapper for jsduck.

NOTE This package used to be called jsduck-from-js; the old name is deprecated, but this is a compatible upgrade.

Installing

Add jsduck as a dev (probably) dependency:

$ npm install --save-dev jsduck;

Usage

var JSDuck = require("jsduck");
var jsduck = new JSDuck(["--out", "tmp"]);
jsduck.doc(["test/dummy.js"]);

You can also pass a custom path for the JSDuck executable:

var jsduck = new JSDuck(["--out", "tmp"], "/path/to/jsduck");
...

In versions 0.2.1 and earlier, the jsduck gem is installed automatically. For security reasons, it no longer does this. Run gem install jsduck to install it.

License

Copyright © 2015 - 2016 Bob W. Hogg. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.