Interface WellknownBundleManifestEntries

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

interface WellknownBundleManifestEntries {
    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;
    "Require-Bundle": BundleDependency[];
    requiredExecutionEnvironment?: string[];
    skipResolve?: boolean;
    startLevel: number;
    title?: string;
    url?: string;
    vendor?: string;
    version: SemVer;
}

Hierarchy (View Summary)

Properties

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

Properties

Optionalactivator

activator?: string

Activator implementation class of the bundle.

ReadonlyautoStartPolicy

autoStartPolicy: "yes" | "no"

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

Optionalbundle

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'.

Optionalcomponents

components?: Record<string, any>[]

The declarative components provided by the bundle.

OptionalcontactAddress

contactAddress?: string

A contact address for the vendor.

Optionalcopyright

copyright?: string

The copyright notice of the bundle.

Optionaldependencies

dependencies?: Record<string, string>

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

Optionaldescription

description?: string

The description of the bundle.

OptionalexcludedExecutionEnvironment

excludedExecutionEnvironment?: string[]

Browsers and devices that are not supported by the bundle.

Optionali18n

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.

Optionali18n-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"]'.

Optionalicon

icon?: unknown

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

Optionalkeywords

keywords?: string[]

A list of keywords for the bundle.

Optionallayer

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.

Optionallicenses

licenses?: { type: string }[]

The licenses of the bundle.

Optionallocation

location?: string

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

Optionalmain

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.

Optionalnamespace

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.

OptionaloptionalDependencies

optionalDependencies?: Record<string, string>

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

OptionalproductName

productName?: string

The product name associated with the bundle.

ReadonlyRequire-Bundle

"Require-Bundle": BundleDependency[]

The dependencies of the bundle.

OptionalrequiredExecutionEnvironment

requiredExecutionEnvironment?: string[]

Browsers and devices that are supported by the bundle.

OptionalskipResolve

skipResolve?: boolean

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

ReadonlystartLevel

startLevel: number

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

Optionaltitle

title?: string

The title of the bundle, used as display name.

Optionalurl

url?: string

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

Optionalvendor

vendor?: string

The vendor of the bundle.

Readonlyversion

version: SemVer

The version of the bundle.

Settings

Member Visibility

On This Page

Properties