rush-lib.ioperationrunner.md

hide_title	true
custom_edit_url
pagination_prev
pagination_next

Home > @microsoft/rush-lib > IOperationRunner

IOperationRunner interface

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

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.

Signature:

export interface IOperationRunner 

Properties

Property	Modifiers	Type	Description
cacheable		boolean	(BETA) Whether or not the operation is cacheable. If false, all cache engines will be disabled for this operation.
isNoOp?	readonly	boolean	(BETA) (Optional) If set to true, this operation is considered a no-op and can be considered always skipped for analysis purposes.
name	readonly	string	(BETA) Name of the operation, for logging.
reportTiming		boolean	(BETA) Indicates that this runner's duration has meaning.
silent		boolean	(BETA) Indicates that this runner is architectural and should not be reported on.
warningsAreAllowed		boolean	(BETA) If set to true, a warning result should not make Rush exit with a nonzero exit code

Methods

Method	Description
executeAsync(context)	(BETA) Method to be executed for the operation.
getConfigHash()	(BETA) Return a hash of the configuration that affects the operation.