Home > @microsoft/rush-lib > IOperationExecutionResult

IOperationExecutionResult interface

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

The IOperationExecutionResult interface represents the results of executing an Operation.

Signature:

export interface IOperationExecutionResult 

Properties

Property	Modifiers	Type	Description
error	readonly	Error | undefined	(ALPHA) The error which occurred while executing this operation, this is stored in case we need it later (for example to re-print errors at end of execution).
logFilePaths	readonly	ILogFilePaths | undefined	(ALPHA) The paths to the log files, if applicable.
metadataFolderPath	readonly	string | undefined	(ALPHA) The relative path to the folder that contains operation metadata. This folder will be automatically included in cache entries.
nonCachedDurationMs	readonly	number | undefined	(ALPHA) The value indicates the duration of the same operation without cache hit.
operation	readonly	Operation	(ALPHA) The operation itself
problemCollector	readonly	IProblemCollector	(ALPHA) Object used to collect problems (errors/warnings/info) encountered during the operation.
silent	readonly	boolean	(ALPHA) If this operation is only present in the graph to maintain dependency relationships, this flag will be set to true.
status	readonly	OperationStatus	(ALPHA) The current execution status of an operation. Operations start in the 'ready' state, but can be 'blocked' if an upstream operation failed. It is 'executing' when the operation is executing. Once execution is complete, it is either 'success' or 'failure'.
stdioSummarizer	readonly	StdioSummarizer	(ALPHA) Object used to report a summary at the end of the Rush invocation.
stopwatch	readonly	IStopwatchResult	(ALPHA) Object tracking execution timing.

Methods

Method	Description
getStateHash()	(ALPHA) Gets the hash of the state of all registered inputs to this operation. Calling this method will throw if Git is not available.
getStateHashComponents()	(ALPHA) Gets the components of the state hash. This is useful for debugging purposes. Calling this method will throw if Git is not available.