@ui5/builder/processors/jsdoc/sdkTransformer

Methods

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

Description:
  • Transform api.json as created by jsdocGenerator for usage in a UI5 SDK
Source:
Parameters:
Name Type Description
parameters object Parameters
Properties
Name Type Description
apiJsonPath string Path to the projects api.json file as created by jsdocGenerator
dotLibraryPath string Path to the projects .library file
dependencyApiJsonPaths Array.<string> List of paths to the api.json files of all dependencies of the project as created by jsdocGenerator
targetApiJsonPath string Path to create the new, transformed api.json resource for
fs fs | module:@ui5/fs/fsInterface Node fs or custom fs interface to use
Returns:
Promise resolving with created resources
Type
Promise.<Array.<@ui5/fs/Resource>>