Skip to content

@ui5/project/ui5Framework/Sapui5MavenSnapshotResolver

@ui5/project/ui5Framework/Sapui5MavenSnapshotResolver

Resolver for the SAPUI5 framework

This Resolver downloads and installs SNAPSHOTS of UI5 libraries from a Maven repository. It's meant for internal usage only as no use cases outside of SAP are known.

Constructor

new @ui5/project/ui5Framework/Sapui5MavenSnapshotResolver(options)

Source: project/lib/ui5Framework/Sapui5MavenSnapshotResolver.js, line 25

Parameters:
NameTypeDescription
options*options
Properties:
NameTypeAttributesDefaultDescription
snapshotEndpointUrlstringoptionalMaven Repository Snapshot URL. Can by overruled
by setting the UI5_MAVEN_SNAPSHOT_ENDPOINT_URL environment variable. If neither is provided,
falling back to the standard Maven settings.xml file (if existing).
versionstringSAPUI5 version to use
sourcesbooleanoptionalfalseWhether to install framework libraries as sources or
pre-built (with build manifest)
cwdstringoptionalprocess.cwd()Current working directory
ui5DataDirstringoptional"~/.ui5"UI5 home directory location. This will be used to store packages,
metadata and configuration used by the resolvers. Relative to process.cwd()
cacheModemodule:@ui5/project/ui5Framework/maven/CacheModeoptionalDefaultCache mode to use

Extends

Methods

Description: Installs the provided libraries and their dependencies

js
const resolver = new Sapui5Resolver({version: "1.76.0"});
// Or for OpenUI5:
// const resolver = new Openui5Resolver({version: "1.76.0"});

resolver.install(["sap.ui.core", "sap.m"]).then(({libraryMetadata}) => {
	// Installation done
}).catch((err) => {
	// Handle installation errors
});

Source: project/lib/ui5Framework/AbstractResolver.js, line 193

Overrides: @ui5/project/ui5Framework/AbstractResolver#install

Parameters:
NameTypeDescription
libraryNamesArray<string>List of library names to be installed
Returns:

Resolves with an object containing the libraryMetadata

Type: @ui5/project/ui5Framework/AbstractResolver~ResolverInstallResult