Class TaskResolverRegistry

The TaskResolverRegistry is the common component for registration and provision of TaskResolvers. Theia will collect all TaskContributions and invoke TaskContribution#registerResolvers for each contribution.

Constructors

Properties

executionResolvers: Map<string, TaskResolver> = ...
onWillProvideTaskResolver: Event<WillResolveTaskProvider> = ...

Emit when the registry provides a registered resolver. i.e. when the TaskResolverRegistry#getResolver function is called.

onWillProvideTaskResolverEmitter: Emitter<WillResolveTaskProvider> = ...
taskResolvers: Map<string, TaskResolver> = ...

Methods

  • Retrieves the TaskResolver registered for the given type task configuration type.

    Parameters

    • type: string

      the task configuration type

    Returns Promise<undefined | TaskResolver>

    a promise of the registered TaskResolver or undefined if no resolver is registered for the given type.

    Deprecated

    since 1.12.0 use getTaskResolver() instead.

  • Registers the given TaskResolver to resolve the TaskConfiguration of the specified type. If there is already a TaskResolver registered for the specified type the registration will be overwritten with the new value.

    Parameters

    • type: string

      the task configuration type for which the given resolver should be registered.

    • resolver: TaskResolver

      the task resolver that should be registered.

    Returns Disposable

    a Disposable that can be invoked to unregister the given resolver

    Deprecated

    since 1.12.0 use registerTaskResolver instead.

  • Registers the given TaskResolver to resolve the TaskConfiguration for the specified type of execution ('shell', 'process' or 'customExecution'). If there is already a TaskResolver registered for the specified type the registration will be overwritten with the new value.

    Parameters

    • type: string

      the task execution type for which the given resolver should be registered.

    • resolver: TaskResolver

      the task resolver that should be registered.

    Returns Disposable

    a Disposable that can be invoked to unregister the given resolver

  • Registers the given TaskResolver to resolve the TaskConfiguration of the specified type. If there is already a TaskResolver registered for the specified type the registration will be overwritten with the new value.

    Parameters

    • type: string

      the task configuration type for which the given resolver should be registered.

    • resolver: TaskResolver

      the task resolver that should be registered.

    Returns Disposable

    a Disposable that can be invoked to unregister the given resolver