@ui5/project/specifications/types/Library

@ui5/project/specifications/types/Library

Library

Extends

Methods

getCustomConfiguration() → {object}

Description:
  • Get the project's customConfiguration
Source:
Overrides:
Returns:
Custom Configuration
Type
object

getFrameworkDependencies() → {Array.<@ui5/project/specifications/Project~FrameworkDependency>}

Description:
  • Get the project's framework dependencies configuration
Source:
Overrides:
Returns:
Framework dependencies configuration
Type
Array.<@ui5/project/specifications/Project~FrameworkDependency>

getFrameworkName() → {string}

Description:
  • Get the project's framework name configuration
Source:
Overrides:
Returns:
Framework name configuration, either OpenUI5 or SAPUI5
Type
string

getFrameworkVersion() → {string}

Description:
  • Get the project's framework version configuration
Source:
Overrides:
Returns:
Framework version configuration, e.g 1.110.0
Type
string

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:
Overrides:
Returns:
Specification ID
Type
string

getKind() → {string}

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

getName() → {string}

Description:
  • Gets the name of this specification. Represents a unique identifier.
Source:
Overrides:
Returns:
Specification name
Type
string

getNamespace() → {string}

Description:
  • Get the project namespace
Source:
Overrides:
Returns:
Project namespace in slash notation (e.g. my/project/name)
Type
string

getReader(optionsopt) → {@ui5/fs/ReaderCollection}

Description:
  • Get a ReaderCollection for accessing all resources of the project in the specified "style":
    • buildtime: Resource paths are always prefixed with /resources/ or /test-resources/ followed by the project's namespace. Any configured build-excludes are applied
    • dist: Resource paths always match with what the UI5 runtime expects. This means that paths generally depend on the project type. Applications for example use a "flat"-like structure, while libraries use a "buildtime"-like structure. Any configured build-excludes are applied
    • runtime: Resource paths always match with what the UI5 runtime expects. This means that paths generally depend on the project type. Applications for example use a "flat"-like structure, while libraries use a "buildtime"-like structure. This style is typically used for serving resources directly. Therefore, build-excludes are not applied
    • flat: Resource paths are never prefixed and namespaces are omitted if possible. Note that project types like "theme-library", which can have multiple namespaces, can't omit them. Any configured build-excludes are applied
    If project resources have been changed through the means of a workspace, those changes are reflected in the provided reader too. Resource readers always use POSIX-style paths.
Source:
Overrides:
Parameters:
Name Type Attributes Description
options object <optional>
Properties
Name Type Attributes Default Description
style string <optional>
 buildtime Path style to access resources. Can be "buildtime", "dist", "runtime" or "flat"
Returns:
A reader collection instance
Type
@ui5/fs/ReaderCollection

getRootPath() → {string}

Description:
  • Gets the specification's file system path. This might not be POSIX-style on some platforms
Source:
Overrides:
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:
Overrides:
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

getSourcePath() → {string}

Description:
  • Get the path of the project's source directory. This might not be POSIX-style on some platforms.
Source:
Overrides:
Returns:
Absolute path to the source directory of the project
Type
string

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

Description:
  • Returns an instance of a helper class representing a Specification Version
Source:
Overrides:
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:
Overrides:
Returns:
Specification type
Type
string

getVersion() → {string}

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

getWorkspace() → {@ui5/fs/ReaderCollection}

Description:
  • Get a resource reader/writer for accessing and modifying a project's resources
Source:
Overrides:
Returns:
A reader collection instance
Type
@ui5/fs/ReaderCollection

isFrameworkProject() → {boolean}

Description:
  • Check whether the project is a UI5-Framework project
Source:
Overrides:
Returns:
True if the project is a framework project
Type
boolean