@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

getKind() → {string}

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

getName() → {string}

Description:
  • Get the name of this specification
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 resource reader for accessing the project resources in a given style. If project resources have been changed through the means of a workspace, those changes are reflected in the provided reader too.
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", "runtime" or "flat" TODO: describe styles
Returns:
A reader collection instance
Type
@ui5/fs/ReaderCollection

getRootPath() → {string}

Description:
  • Get 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:
  • Get 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:
  • 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:
Overrides:
Returns:
Specification type
Type
string

getVersion() → {string}

Description:
  • Get 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