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.

Index

Constructors

Properties

executionResolvers onWillProvideTaskResolver onWillProvideTaskResolverEmitter taskResolvers

Methods

getExecutionResolver getResolver getTaskResolver register registerExecutionResolver registerTaskResolver

Constructors

constructor

new TaskResolverRegistry(): TaskResolverRegistry
Returns TaskResolverRegistry

Properties

`Protected`executionResolvers

executionResolvers: Map<string, TaskResolver> = ...

`Readonly`onWillProvideTaskResolver

onWillProvideTaskResolver: Event<WillResolveTaskProvider> = ...

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

`Protected` `Readonly`onWillProvideTaskResolverEmitter

onWillProvideTaskResolverEmitter: Emitter<WillResolveTaskProvider> = ...

`Protected`taskResolvers

taskResolvers: Map<string, TaskResolver> = ...

Methods

getExecutionResolver

getExecutionResolver(executionType: string): undefined | TaskResolver
Retrieves the TaskResolver registered for the given type of execution ('shell', 'process' or 'customExecution')..
Parameters
- executionType: string
Returns undefined | TaskResolver
a promise of the registered TaskResolver or undefined if no resolver is registered for the given type.
- Defined in packages/task/src/browser/task-contribution.ts:194

getResolver

getResolver(type: string): Promise<undefined | TaskResolver>
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.
- Defined in packages/task/src/browser/task-contribution.ts:152

getTaskResolver

getTaskResolver(type: string): Promise<undefined | TaskResolver>
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.
- Defined in packages/task/src/browser/task-contribution.ts:162

register

register(type: string, resolver: TaskResolver): Disposable
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.
- Defined in packages/task/src/browser/task-contribution.ts:118

registerExecutionResolver

registerExecutionResolver(type: string, resolver: TaskResolver): Disposable
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
- Defined in packages/task/src/browser/task-contribution.ts:178

registerTaskResolver

registerTaskResolver(type: string, resolver: TaskResolver): Disposable
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
- Defined in packages/task/src/browser/task-contribution.ts:133