UI5 CLI

Appearance

@ui5/project/specifications/extensions/ServerMiddleware ​

@ui5/project/specifications/extensions/ServerMiddleware ​

ServerMiddleware

Extends ​

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

Overrides: @ui5/project/specifications/Extension#getId

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

Overrides: @ui5/project/specifications/Extension#getKind

Returns: ​

Specification kind

Type: string

(async) getMiddleware()
​

Source: project/lib/specifications/extensions/ServerMiddleware.js, line 23

getName() → {string}
​

Description: Gets the name of this specification. Represents a unique identifier.

Source: project/lib/specifications/Specification.js, line 186

Overrides: @ui5/project/specifications/Extension#getName

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

Overrides: @ui5/project/specifications/Extension#getRootPath

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

Overrides: @ui5/project/specifications/Extension#getRootReader

Parameters: ​
NameTypeAttributesDescription
parametersobjectoptionalParameters
Properties:
NameTypeAttributesDefaultDescription
useGitignoreobjectoptionaltrueWhether 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: project/lib/specifications/Specification.js, line 218

Overrides: @ui5/project/specifications/Extension#getSpecVersion

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

Overrides: @ui5/project/specifications/Extension#getType

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

Overrides: @ui5/project/specifications/Extension#getVersion

Returns: ​

Project version

Type: string