@ui5/builder/processors/jsdoc/apiIndexGenerator

Methods

(static) default(parameters) → {Promise.<Array.<@ui5/fs/Resource>>}

Description:
  • Compiles API index resources from all api.json resources available in the given test resources directory as created by the sdkTransformer processor. The resulting index resources (e.g. api-index.json, api-index-deprecated.json, api-index-experimental.json and api-index-since.json) are mainly to be used in the SDK.
Source:
Parameters:
Name Type Description
parameters object Parameters
Properties
Name Type Description
versionInfoPath string Path to sap-ui-version.json resource
testResourcesRootPath string Path to /test-resources root directory in the given fs
targetApiIndexPath string Path to create the generated API index JSON resource for
targetApiIndexDeprecatedPath string Path to create the generated API index "deprecated" JSON resource for
targetApiIndexExperimentalPath string Path to create the generated API index "experimental" JSON resource for
targetApiIndexSincePath string Path to create the generated API index "since" JSON resource for
fs fs | module:@ui5/fs/fsInterface Node fs or custom fs interface to use
Returns:
Promise resolving with created resources api-index.json, api-index-deprecated.json, api-index-experimental.json and api-index-since.json (names depend on the supplied paths)
Type
Promise.<Array.<@ui5/fs/Resource>>