@openfabr/cdf / Exports / PackageManifest
Interface: PackageManifest
Interface for modelling a package manifest json file that provides informations about the package. Crucially it also carries two references respectively to a) a json schema file for validating json config files and b) a template file for custom code blocks.
Hierarchy
↳ PackageManifest
Table of contents
Properties
Properties
cdf
• Readonly cdf: string
The version of OpenFABR CDF that this package is compatible with, following semantic versioning.
Defined in
constructs
• Readonly constructs: ConstructsInfo
Information about constructs defined in the package.
Defined in
description
• Optional Readonly description: string
The description of the package.
Defined in
icon
• Optional Readonly icon: string
Inherited from
Defined in
identifier
• Readonly identifier: string
The unique identifier of the package.
Defined in
license
• Readonly license: string
The SPDX license identifier for the license that the package is released under.
See
Defined in
name
• Optional Readonly name: string
The descriptive name of the package.
Defined in
support
• Optional Readonly support: SupportInfo
Information about the support provided for the package.
Defined in
tooling
• Readonly tooling: ToolingInfo
Information about tooling the package relies on.
Defined in
vendor
• Readonly vendor: string
The author of the package.