Skip to content

@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

src/lib/metadata.ts:229


constructs

Readonly constructs: ConstructsInfo

Information about constructs defined in the package.

Defined in

src/lib/metadata.ts:237


description

Optional Readonly description: string

The description of the package.

Defined in

src/lib/metadata.ts:221


icon

Optional Readonly icon: string

Inherited from

OptionalIconAware.icon

Defined in

src/lib/metadata.ts:17


identifier

Readonly identifier: string

The unique identifier of the package.

Defined in

src/lib/metadata.ts:207


license

Readonly license: string

The SPDX license identifier for the license that the package is released under.

See

SPDX

Defined in

src/lib/metadata.ts:217


name

Optional Readonly name: string

The descriptive name of the package.

Defined in

src/lib/metadata.ts:203


support

Optional Readonly support: SupportInfo

Information about the support provided for the package.

Defined in

src/lib/metadata.ts:225


tooling

Readonly tooling: ToolingInfo

Information about tooling the package relies on.

Defined in

src/lib/metadata.ts:233


vendor

Readonly vendor: string

The author of the package.

Defined in

src/lib/metadata.ts:211