v9.0.0

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, via file-set, by this lib). It was necessary to upgrade node-glob to the latest version to avoid using a deprecated, unsupported old version.
  • 30th Aug 2024: Update! Support for Node v12 was restored in jsdoc-api v9.3.0
• Removed all synchronous methods. Both .explain() and .render() are now async-only.
• Previously, passing either option.files or option.source was mandatory. Now, it is either option.files, option.source or option.configure. #27

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 simplified, 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.