@ui5/builder/tasks/jsdoc/generateApiIndex

Methods

(static) default(parameters) → {Promise.<undefined>}

Description:
  • Compiles an api-index.json resource from all available api.json resources as created by the executeJsdocSdkTransformation task. The resulting api-index.json resource is mainly to be used in the SDK.
Source:
Parameters:
Name Type Description
parameters object Parameters
Properties
Name Type Description
workspace @ui5/fs/DuplexCollection DuplexCollection to read and write files
dependencies @ui5/fs/AbstractReader Reader or Collection to read dependency files
options object Options
Properties
Name Type Description
projectName string Project name
Returns:
Promise resolving with undefined once data has been written
Type
Promise.<undefined>