jsdoc-api

Non-breaking changes since v9.0.2

• To avoid this jsdoc issue, jsdoc-api now uses its own bespoke cache directory at ~/.jsdoc-api/cache instead of os.tmpdir(). See #19.
• While running the underlying jsdoc child process, the maxBuffer used is now 100MB to help users processing huge amounts of input #24

There are no changes to the jsdoc-api output.

Breaking changes since v8.1.1

• The minimum required Node version is now v20.
  • A change imposed upon the project by node-glob (used by this lib). It was necessary to upgrade node-glob to the latest version to avoid using a deprecated, unsupported old version.
• Removed all synchronous methods. Both .explain() and .render() are now async-only.

Non-breaking changes

• Fixed an issue where setting { pedantic: false } confused the underlying jsdoc. #22
• Can now pass an array of strings to .source. #11

Other improvements

• Jsdoc-api is now an ES Module.
• Dependency tree cleaned up
  • Coveralls, collect-json, collect-all, fs-then-native and temp-path all factored out of the project.
  • Many others upgraded to the latest versions, removing deprecation warnings.
• Readme examples improved
• Example code added in the /examples folder.
• Codebase simplied, in general.

Upgrade notes

• Update your code replacing any use of explainSync() with await explain() and renderSync() with await render().
• Ensure you're on Node v20 or above
• That's it. There are no changes to the jsdoc-api output - your generated documentation should look the same.

Breaking change since 7.1.1

• Upgraded to use jsdoc v4.0.0. Jsdoc replaced its internal use of taffy-db with a handrolled polyfill.

• Removed the streaming interface (.createExplainStream()).

The main (and possibly only) benefit of streams is the ability to receive and process data as it is being created, without first needing to wait for the data source to finish. However, jsdoc-api was unable to supply output to .createExplainStream() before the underlying jsdoc process had completed, thus leaving no reason for the streaming interface to exist.