map.apps Bundle APIs 4.20.0
    Preparing search index...

    Interface BundleManifestJson

    Defines 'manifest.json' properties of map.apps

    interface BundleManifestJson {
        activator?: string;
        autoStartPolicy?: boolean | "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?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown

      Any additional properties. The 'manifest.json' is extensible and can also have other keys.

    Index

    Properties

    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

    activator?: string

    Activator implementation class of the bundle.

    autoStartPolicy?: boolean | "yes" | "no"

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

    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'.
    components?: Record<string, any>[]

    The declarative components provided by the bundle.

    contactAddress?: string

    A contact address for the vendor.

    copyright?: string

    The copyright notice of the bundle.

    dependencies?: Record<string, string>

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

    description?: string

    The description of the bundle.

    excludedExecutionEnvironment?: string[]

    Browsers and devices that are not supported by the bundle.

    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.

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

    icon?: unknown

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

    keywords?: string[]

    A list of keywords for the bundle.

    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.

    licenses?: { type: string }[]

    The licenses of the bundle.

    location?: string

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

    main?: string

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

    name: string

    The symbolic name (unique ID) of the bundle.

    namespace?: string

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

    This property is obsolete and should not be used anymore.

    optionalDependencies?: Record<string, string>

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

    productName?: string

    The product name associated with the bundle.

    requiredExecutionEnvironment?: string[]

    Browsers and devices that are supported by the bundle.

    skipResolve?: boolean

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

    startLevel?: number

    The start level of the bundle. The start level is a number between 1 and 100. It can be used to start a bundle earlier or later than other bundles. The default start level is 50. Smaller numbers will start earlier.

    title?: string

    The title of the bundle, used as display name.

    url?: string

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

    vendor?: string

    The vendor of the bundle.

    version?: string

    The version of the bundle.

    Settings

    Member Visibility

    On This Page

    Properties