Skip to content

@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: builder/lib/processors/jsdoc/sdkTransformer.js, line 9

Parameters:
NameTypeDescription
parametersobjectParameters
Properties:
NameTypeDescription
apiJsonPathstringPath to the projects api.json file as created by
jsdocGenerator
dotLibraryPathstringPath to the projects .library file
dependencyApiJsonPathsArray<string>List of paths to the api.json files of all dependencies of
the project as created by jsdocGenerator
targetApiJsonPathstringPath to create the new, transformed api.json resource for
fsfs | module:@ui5/fs/fsInterfaceNode fs or
custom fs interface to use
Returns:

Promise resolving with created resources

Type: Promise<Array<@ui5/fs/Resource>>