@ui5/project/config/Configuration

@ui5/project/config/Configuration

Provides basic configuration for @ui5/project. Reads/writes configuration from/to ~/.ui5rc

Constructor

new @ui5/project/config/Configuration(configuration)

Source: project/lib/config/Configuration.js, line 12

Parameters:

Name	Type	Description
configuration	object	Properties: Name Type Attributes Description mavenSnapshotEndpointUrl string optional ui5DataDir string optional

Members

OPTIONS

Description: A list of all configuration options.

Source: project/lib/config/Configuration.js, line 19

A list of all configuration options.

Methods

getMavenSnapshotEndpointUrl() → {string}

Description: Maven Repository Snapshot URL. Used to download artifacts and packages from Maven's build-snapshots URL.

Source: project/lib/config/Configuration.js, line 51

Returns:

Type: string

getUi5DataDir() → {string}

Description: Configurable directory where the framework artefacts are stored.

Source: project/lib/config/Configuration.js, line 61

Returns:

Type: string

toJson() → {object}

Source: project/lib/config/Configuration.js, line 69

Returns:

The configuration in a JSON format

Type: object

(async, static) fromFile(filePathopt) → {Promise<@ui5/project/config/Configuration>}

Description: Creates Configuration from a JSON file

Source: project/lib/config/Configuration.js, line 81

Parameters:

Name	Type	Attributes	Default	Description
filePath	string	optional	"~/.ui5rc"	Path to configuration JSON file

Returns:

Configuration instance

Type: Promise<@ui5/project/config/Configuration>

(async, static) toFile(config, filePathopt) → {Promise<void>}

Description: Saves Configuration to a JSON file

Source: project/lib/config/Configuration.js, line 119

Parameters:

Name	Type	Attributes	Default	Description
config	@ui5/project/config/Configuration			Configuration to save
filePath	string	optional	"~/.ui5rc"	Path to configuration JSON file

Returns:

Type: Promise<void>