Theia API Documentation v1.75.0
    Preparing search index...

    Interface PluginPackage

    Loaded plugin package with stricter fields used by @theia/plugin-ext.

    interface PluginPackage {
        activationEvents?: string[];
        browser?: string;
        capabilities?: PluginPackageCapabilities;
        contributes?: PluginPackageContribution;
        description: string;
        displayName: string;
        engines: { [key: string]: string };
        extensionDependencies?: string[];
        extensionKind?: ("ui" | "workspace")[];
        extensionPack?: string[];
        headless?: { activationEvents?: string[] };
        icon?: string;
        l10n?: string;
        main?: string;
        name: string;
        packagePath: string;
        packageUri?: string;
        publisher: undefined | string;
        theiaPlugin?: { backend?: string; frontend?: string; headless?: string };
        type?: "module" | "commonjs";
        version: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    activationEvents? browser? capabilities? contributes? description displayName engines extensionDependencies? extensionKind? extensionPack? headless? icon? l10n? main? name packagePath packageUri? publisher theiaPlugin? type? version

    Properties

    activationEvents?: string[]
    browser?: string
    capabilities?: PluginPackageCapabilities
    contributes?: PluginPackageContribution

    Raw contributes section from package.json before normalization.

    description: string
    displayName: string
    engines: { [key: string]: string }
    extensionDependencies?: string[]
    extensionKind?: ("ui" | "workspace")[]
    extensionPack?: string[]
    headless?: { activationEvents?: string[] }

    Analogues of declarations offered by VS Code plugins, but for the headless instantiation.

    Type Declaration

    • OptionalactivationEvents?: string[]

      Activation events supported in headless mode, if any.

    icon?: string
    l10n?: string
    main?: string
    name: string
    packagePath: string
    packageUri?: string
    publisher: undefined | string
    theiaPlugin?: { backend?: string; frontend?: string; headless?: string }
    type?: "module" | "commonjs"
    version: string

    Settings

    Member Visibility

    On This Page

    Properties