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

    Interface PluginDeployerEntry

    interface PluginDeployerEntry {
        rootPath: string;
        type: PluginType;
        accept(...types: PluginDeployerEntryType[]): void;
        getChanges(): string[];
        getValue<T>(key: string): T;
        hasError(): boolean;
        id(): string;
        isAccepted(...types: PluginDeployerEntryType[]): boolean;
        isDirectory(): Promise<boolean>;
        isFile(): Promise<boolean>;
        isResolved(): boolean;
        originalPath(): string;
        path(): string;
        resolvedBy(): string;
        storeValue<T>(key: string, value: T): void;
        updatePath(newPath: string): void;
    }
    Index

    Properties

    rootPath type

    Methods

    accept getChanges getValue hasError id isAccepted isDirectory isFile isResolved originalPath path resolvedBy storeValue updatePath

    Properties

    rootPath: string

    A fs path to a directory where a plugin is located. Depending on a plugin format it can be different from path. Use path if you want to resolve something within a plugin, like README.md file. Use rootPath if you want to manipulate the entire plugin location, like delete or move it.

    type: PluginType

    Methods

    • Returns string[]

    • Get a specific entry

      Type Parameters

      • T

      Parameters

      • key: string

      Returns T

    • Returns boolean

    • ID (before any resolution)

      Returns string

    • Accepted when a handler is telling this location can go live

      Parameters

      Returns boolean

    • Returns Promise<boolean>

    • Returns Promise<boolean>

    • Resolved if a resolver has handle this plugin

      Returns boolean

    • Original resolved path

      Returns string

    • Local path on the filesystem.

      Returns string

    • Returns string

    • Store a value

      Type Parameters

      • T

      Parameters

      • key: string
      • value: T

      Returns void

    • Update path

      Parameters

      • newPath: string

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods