@ui5/project/specifications/Specification
@ui5/project/specifications/Specification
Abstract superclass for all projects and extensions
Methods
getId() → {string}
Description: Gets the ID of this specification.
Note: Only to be used for special occasions as it is specific to the provider that was used and does not necessarily represent something defined by the project.
For general purposes of a unique identifier use getName instead.
Source: project/lib/specifications/Specification.js, line 176
Returns:
Specification ID
Type: string
getKind() → {string}
Description: Gets the kind of this specification, for example project or extension
Source: project/lib/specifications/Specification.js, line 196
Returns:
Specification kind
Type: string
getName() → {string}
Description: Gets the name of this specification. Represents a unique identifier.
Source: project/lib/specifications/Specification.js, line 186
Returns:
Specification name
Type: string
getRootPath() → {string}
Description: Gets the specification's file system path. This might not be POSIX-style on some platforms
Source: project/lib/specifications/Specification.js, line 238
Returns:
Project root path
Type: string
getRootReader(parametersopt) → {@ui5/fs/ReaderCollection}
Description: Gets a ReaderCollection for the root directory of the specification. Resource readers always use POSIX-style
Source: project/lib/specifications/Specification.js, line 253
Parameters:
| Name | Type | Attributes | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
parameters | object | optional | Parameters Properties:
|
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: project/lib/specifications/Specification.js, line 218
Returns:
Type: @ui5/project/specifications/SpecificationVersion
getType() → {string}
Description: Gets the type of this specification, for example application or library in case of projects, and task or server-middleware in case of extensions
Source: project/lib/specifications/Specification.js, line 208
Returns:
Specification type
Type: string
getVersion() → {string}
Description: Gets the specification's generic version, as typically defined in a package.json
Source: project/lib/specifications/Specification.js, line 228
Returns:
Project version
Type: string
(async, static) create(parameters)
Description: Create a Specification instance for the given parameters
Source: project/lib/specifications/Specification.js, line 28
Parameters:
| Name | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
parameters | object | Properties:
|