Class TaskDefinitionRegistry

Hierarchy

TaskDefinitionRegistry

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TaskDefinitionRegistry(): TaskDefinitionRegistry

Returns TaskDefinitionRegistry

Properties

Private definitions

definitions: Map<string, TaskDefinition[]> = ...

Protected Readonly onDidRegisterTaskDefinitionEmitter

onDidRegisterTaskDefinitionEmitter: Emitter<void> = ...

Protected Readonly onDidUnregisterTaskDefinitionEmitter

onDidUnregisterTaskDefinitionEmitter: Emitter<void> = ...

Accessors

onDidRegisterTaskDefinition

get onDidRegisterTaskDefinition(): Event<void>

- Defined in packages/task/src/browser/task-definition-registry.ts:30
Returns Event<void>

onDidUnregisterTaskDefinition

get onDidUnregisterTaskDefinition(): Event<void>

- Defined in packages/task/src/browser/task-definition-registry.ts:35
Returns Event<void>

Methods

compareTasks

compareTasks(one: TaskConfiguration | TaskCustomization, other: TaskConfiguration | TaskCustomization): boolean

- Defined in packages/task/src/browser/task-definition-registry.ts:110
Parameters
- one: TaskConfiguration | TaskCustomization
- other: TaskConfiguration | TaskCustomization
Returns boolean

getAll

getAll(): TaskDefinition[]

- Defined in packages/task/src/browser/task-definition-registry.ts:43
Returns all task definitions that are registered

Returns TaskDefinition[]
the task definitions that are registered

getDefinition

getDefinition(taskConfiguration: TaskConfiguration | TaskCustomization): undefined | TaskDefinition

- Defined in packages/task/src/browser/task-definition-registry.ts:69
Finds the task definition from the registry for the task configuration. The task configuration is considered as a "match" to the task definition if it has all the required properties. In case that more than one task definition is found, return the one that has the biggest number of matched properties.

Parameters
- taskConfiguration: TaskConfiguration | TaskCustomization
  
  the task configuration
Returns undefined | TaskDefinition
the task definition for the task configuration. If the task definition is not found, undefined is returned.

getDefinitions

getDefinitions(taskType: string): TaskDefinition[]

- Defined in packages/task/src/browser/task-definition-registry.ts:57
Finds the task definition(s) from the registry with the given taskType.

Parameters
- taskType: string
  
  the type of the task
Returns TaskDefinition[]
an array of the task definitions. If no task definitions are found, an empty array is returned.

register

register(definition: TaskDefinition): Disposable

- Defined in packages/task/src/browser/task-definition-registry.ts:95
Add a task definition to the registry.

Parameters
- definition: TaskDefinition
  
  the task definition to be added.
Returns Disposable