Interface BundleManifestEntries

Helper to access the parsed header information of the 'manifest.json' of the bundle.

interface BundleManifestEntries {
    Require-Bundle: BundleDependency[];
    activator?: string;
    autoStartPolicy: "yes" | "no";
    bundle?: boolean;
    components?: Record<string, any>[];
    contactAddress?: string;
    copyright?: string;
    dependencies?: Record<string, string>;
    description?: string;
    excludedExecutionEnvironment?: string[];
    i18n?: string[];
    i18n-extension?: string[];
    icon?: unknown;
    keywords?: string[];
    layer?: string;
    licenses?: {
        type: string;
    }[];
    location?: string;
    main?: string;
    name: string;
    namespace?: string;
    optionalDependencies?: Record<string, string>;
    productName?: string;
    requiredExecutionEnvironment?: string[];
    skipResolve?: boolean;
    startLevel: number;
    title?: string;
    url?: string;
    vendor?: string;
    version: SemVer;
    [key: string]: unknown;
}

Hierarchy (view full)

Indexable

[key: string]: unknown

The bundle header information may also have additional properties

Properties

Require-Bundle activator? autoStartPolicy bundle? components? contactAddress? copyright? dependencies? description? excludedExecutionEnvironment? i18n? i18n-extension? icon? keywords? layer? licenses? location? main? name namespace? optionalDependencies? productName? requiredExecutionEnvironment? skipResolve? startLevel title? url? vendor? version

Properties

Readonly Require-Bundle

Require-Bundle: BundleDependency[]

The dependencies of the bundle.

Optional activator

activator?: string

Activator implementation class of the bundle.

Readonly autoStartPolicy

autoStartPolicy: "yes" | "no"

Defines, if the bundle starts automatically. Default is 'yes'.

Optional bundle

bundle?: boolean

Indicates, if this JavaScript package is a 'bundle'. If true, the default value for the field:

  • 'main' is "main"
  • 'i18n' is ["bundle"]
  • 'layer' is "module" If false, the default values do not apply and the fields are considered 'empty'.

Optional components

components?: Record<string, any>[]

The declarative components provided by the bundle.

Optional contactAddress

contactAddress?: string

A contact address for the vendor.

Optional copyright

copyright?: string

The copyright notice of the bundle.

Optional dependencies

dependencies?: Record<string, string>

Dependencies of the bundle. e.g. { apprt-core: "~4.2.3" }

Optional description

description?: string

The description of the bundle.

Optional excludedExecutionEnvironment

excludedExecutionEnvironment?: string[]

Browsers and devices that are not supported by the bundle.

Optional i18n

i18n?: string[]

The i18n files of the bundle. If used, the value should be ["bundle"], pointing to the i18n files located at /nls/bundle.js.

Optional i18n-extension

i18n-extension?: string[]

This key is only valid, if the bundle is an i18n extension bundle. In this case, it extends or overwrites the global i18n keys of other bundles. Example value: '["bundle"]'.

Optional icon

icon?: unknown

The icon of the bundle. This field is not exactly specified.

Optional keywords

keywords?: string[]

A list of keywords for the bundle.

Optional layer

layer?: string

The layer file of the bundle. It contains compressed JavaScript resources. This file is fetched by the loading system, if the bundle is required by an app.

Optional licenses

licenses?: {
    type: string;
}[]

The licenses of the bundle.

Type declaration

  • type: string

Optional location

location?: string

The location of the bundle. It is calculated by the JS registry backend.

Optional main

main?: string

The main entry point of the bundle. Typically, it is no longer required.

name

name: string

The symbolic name (unique ID) of the bundle.

Optional namespace

namespace?: string

The namespace of the bundle. The namespace is used to register the bundle in the AMD loader.

Deprecated

This property is obsolete and should not be used anymore.

Optional optionalDependencies

optionalDependencies?: Record<string, string>

Optional Dependencies of the bundle. e.g. { apprt-core: "~4.2.3" }

Optional productName

productName?: string

The product name associated with the bundle.

Optional requiredExecutionEnvironment

requiredExecutionEnvironment?: string[]

Browsers and devices that are supported by the bundle.

Optional skipResolve

skipResolve?: boolean

Indicates, if the 'resolve' phase of the bundle start should be skipped.

Readonly startLevel

startLevel: number

The start level of the bundle. The default start level is 50. Smaller numbers will start earlier.

Optional title

title?: string

The title of the bundle, used as display name.

Optional url

url?: string

The URL of the bundle. Points e.g. to the bundle's code.

Optional vendor

vendor?: string

The vendor of the bundle.

Readonly version

version: SemVer

The version of the bundle.

Settings

Member Visibility

Theme

On This Page

Require-BundleactivatorautoStartPolicybundlecomponentscontactAddresscopyrightdependenciesdescriptionexcludedExecutionEnvironmenti18ni18n-extensioniconkeywordslayerlicenseslocationmainnamenamespaceoptionalDependenciesproductNamerequiredExecutionEnvironmentskipResolvestartLeveltitleurlvendorversion

Generated using TypeDoc