Rush StackShopBlogEvents
Skip to main content

Home > @microsoft/rush-lib > IOperationRunner

IOperationRunner interface

This API is provided as a 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

PropertyModifiersTypeDescription
isCacheWriteAllowedboolean(BETA) Indicates if the output of this operation may be written to the cache
isSkipAllowedboolean(BETA) This flag determines if the operation is allowed to be skipped if up to date.
namereadonlystring(BETA) Name of the operation, for logging.
reportTimingboolean(BETA) Indicates that this runner's duration has meaning.
silentboolean(BETA) Indicates that this runner is architectural and should not be reported on.
warningsAreAllowedboolean(BETA) If set to true, a warning result should not make Rush exit with a nonzero exit code

Methods

MethodDescription
executeAsync(context)(BETA) Method to be executed for the operation.