Home > @rushstack/operation-graph

operation-graph package

Classes

Class	Description
Operation	(BETA) The Operation class is a node in the dependency graph of work that needs to be scheduled by the OperationExecutionManager. Each Operation has a runner member of type IOperationRunner, whose implementation manages the actual process of running a single operation. The graph of Operation instances will be cloned into a separate execution graph after processing.
OperationError	(BETA) Encapsulates information about an error
OperationExecutionManager	(BETA) A class which manages the execution of a set of tasks with interdependencies. Initially, and at the end of each task execution, all unblocked tasks are added to a ready queue which is then executed. This is done continually until all tasks are complete, or prematurely fails if any of the tasks fail.
OperationGroupRecord	(BETA) Meta-entity that tracks information about a group of related operations.
Stopwatch	Represents a typical timer/stopwatch which keeps track of elapsed time in between two events.
WatchLoop	(BETA) This class implements a watch loop.

Enumerations

Enumeration	Description
OperationStatus	(BETA) Enumeration defining potential states of an operation

Interfaces

Interface	Description
IAfterExecuteEventMessage	(BETA) A message sent to the host upon completion of a run of this task.
ICancelCommandMessage	(BETA) A message sent by the host to tell the watch loop to cancel the current run.
IExecuteOperationContext	(BETA) Information provided to executeAsync by the OperationExecutionManager.
IExitCommandMessage	(BETA) A message sent by the host to tell the watch loop to shutdown gracefully.
IOperationExecutionOptions	(BETA) Options for the current run.
IOperationOptions	(BETA) Options for constructing a new Operation.
IOperationRunner	(BETA) The Operation class is a node in the dependency graph of work that needs to be scheduled by the OperationExecutionManager. Each Operation has a runner member of type IOperationRunner, whose implementation manages the actual process for running a single operation.
IOperationRunnerContext	(BETA) Information passed to the executing IOperationRunner
IOperationState	(BETA) Interface contract for a single state of an operation.
IOperationStates	(BETA) Interface contract for the current and past state of an operation.
IRequestRunEventMessage	(BETA) A message sent to the host to ask it to run this task.
IRunCommandMessage	(BETA) A message sent by the host to tell the watch loop to perform a single run.
ISyncCommandMessage	(BETA) A message sent by the host to ask for to resync status information.
ISyncEventMessage	(BETA) A message sent to the host upon connection of the channel, to indicate to the host that this task supports the protocol and to provide baseline status information.
IWatchLoopOptions	(BETA) Callbacks for the watch loop.
IWatchLoopState	(BETA) The public API surface of the watch loop, for use in the executeAsync callback.

Type Aliases

Type Alias	Description
CommandMessageFromHost	(BETA) The set of known messages from the host to the watch loop.
EventMessageFromClient	(BETA) The set of known messages from the watch loop to the host.
IPCHost	(BETA) The interface contract for IPC send/receive, to support alternate channels and unit tests.
OperationRequestRunCallback	(BETA) Type for the requestRun callback.