Class TaskDefinitionRegistry

Index

Constructors

Properties

onDidRegisterTaskDefinitionEmitter onDidUnregisterTaskDefinitionEmitter

Accessors

onDidRegisterTaskDefinition onDidUnregisterTaskDefinition

Methods

compareTasks getAll getDefinition getDefinitions register

Constructors

constructor

new TaskDefinitionRegistry(): TaskDefinitionRegistry
Returns TaskDefinitionRegistry

Properties

`Protected` `Readonly`onDidRegisterTaskDefinitionEmitter

onDidRegisterTaskDefinitionEmitter: Emitter<void> = ...

`Protected` `Readonly`onDidUnregisterTaskDefinitionEmitter

onDidUnregisterTaskDefinitionEmitter: Emitter<void> = ...

Accessors

onDidRegisterTaskDefinition

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

onDidUnregisterTaskDefinition

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

Methods

compareTasks

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

getAll

getAll(): TaskDefinition[]
Returns all task definitions that are registered

Returns TaskDefinition[]
the task definitions that are registered
- Defined in packages/task/src/browser/task-definition-registry.ts:43

getDefinition

getDefinition(
taskConfiguration: TaskConfiguration | TaskCustomization,
): undefined | TaskDefinition
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.
- Defined in packages/task/src/browser/task-definition-registry.ts:69

getDefinitions

getDefinitions(taskType: string): TaskDefinition[]
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.
- Defined in packages/task/src/browser/task-definition-registry.ts:57

register

register(definition: TaskDefinition): Disposable
Add a task definition to the registry.
Parameters
- definition: TaskDefinition
  the task definition to be added.
Returns Disposable
- Defined in packages/task/src/browser/task-definition-registry.ts:95