@ui5/project/specifications/Specification

@ui5/project/specifications/Specification

Abstract superclass for all projects and extensions

Methods

getKind() → {string}

Description:
  • Get the kind of this specification, for example project or extension
Source:
Returns:
Specification kind
Type
string

getName() → {string}

Description:
  • Get the name of this specification
Source:
Returns:
Specification name
Type
string

getRootPath() → {string}

Description:
  • Get the specification's file system path. This might not be POSIX-style on some platforms
Source:
Returns:
Project root path
Type
string

getRootReader(parametersopt) → {@ui5/fs/ReaderCollection}

Description:
  • Get a ReaderCollection for the root directory of the specification. Resource readers always use POSIX-style
Source:
Parameters:
Name Type Attributes Description
parameters object <optional>
 Parameters
Properties
Name Type Attributes Default Description
useGitignore object <optional>
 true Whether to apply any excludes defined in an optional .gitignore in the root directory
Returns:
Reader collection
Type
@ui5/fs/ReaderCollection

getSpecVersion() → {@ui5/project/specifications/SpecificationVersion}

Description:
  • Returns an instance of a helper class representing a Specification Version
Source:
Returns:
Type
@ui5/project/specifications/SpecificationVersion

getType() → {string}

Description:
  • Get the type of this specification, for example application or library in case of projects, and task or server-middleware in case of extensions
Source:
Returns:
Specification type
Type
string

getVersion() → {string}

Description:
  • Get the specification's generic version, as typically defined in a package.json
Source:
Returns:
Project version
Type
string

(async, static) create(parameters)

Description:
  • Create a Specification instance for the given parameters
Source:
Parameters:
Name Type Description
parameters object
Properties
Name Type Description
id string Unique ID
version string Version
modulePath string Absolute File System path to access resources
configuration object Type-dependent configuration object. Typically defined in a ui5.yaml