## API Report File for "@rushstack/operation-graph"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
///
import type { ITerminal } from '@rushstack/terminal';
// @beta
export type CommandMessageFromHost = ICancelCommandMessage | IExitCommandMessage | IRunCommandMessage | ISyncCommandMessage;
// @beta
export type EventMessageFromClient = IRequestRunEventMessage | IAfterExecuteEventMessage | ISyncEventMessage;
// @beta
export interface IAfterExecuteEventMessage {
// (undocumented)
event: 'after-execute';
residentMemoryBytes?: number;
// (undocumented)
status: OperationStatus;
}
// @beta
export interface ICancelCommandMessage {
// (undocumented)
command: 'cancel';
}
// @beta
export interface IExecuteOperationContext extends Omit {
afterExecute(operation: Operation, state: IOperationState): void;
beforeExecute(operation: Operation, state: IOperationState): void;
queueWork(workFn: () => Promise, priority: number): Promise;
requestRun?: OperationRequestRunCallback;
terminal: ITerminal;
}
// @beta
export interface IExitCommandMessage {
// (undocumented)
command: 'exit';
}
// @beta
export interface IOperationExecutionOptions {
// (undocumented)
abortSignal: AbortSignal;
// (undocumented)
afterExecuteOperation?: (operation: Operation) => void;
// (undocumented)
afterExecuteOperationGroup?: (operationGroup: OperationGroupRecord) => void;
// (undocumented)
beforeExecuteOperation?: (operation: Operation) => void;
// (undocumented)
beforeExecuteOperationGroup?: (operationGroup: OperationGroupRecord) => void;
// (undocumented)
parallelism: number;
// (undocumented)
requestRun?: OperationRequestRunCallback;
// (undocumented)
terminal: ITerminal;
}
// @beta
export interface IOperationOptions {
group?: OperationGroupRecord | undefined;
metadata?: TMetadata | undefined;
name: string;
runner?: IOperationRunner | undefined;
weight?: number | undefined;
}
// @beta
export interface IOperationRunner {
executeAsync(context: IOperationRunnerContext): Promise;
readonly name: string;
silent: boolean;
}
// @beta
export interface IOperationRunnerContext {
abortSignal: AbortSignal;
isFirstRun: boolean;
requestRun?: (detail?: string) => void;
}
// @beta
export interface IOperationState {
error: OperationError | undefined;
hasBeenRun: boolean;
status: OperationStatus;
stopwatch: Stopwatch;
}
// @beta
export interface IOperationStates {
readonly lastState: Readonly | undefined;
readonly state: Readonly | undefined;
}
// @beta
export type IPCHost = Pick;
// @beta
export interface IRequestRunEventMessage {
detail?: string;
// (undocumented)
event: 'requestRun';
requestor: string;
}
// @beta
export interface IRunCommandMessage {
// (undocumented)
command: 'run';
}
// @beta
export interface ISyncCommandMessage {
// (undocumented)
command: 'sync';
}
// @beta
export interface ISyncEventMessage {
// (undocumented)
event: 'sync';
// (undocumented)
status: OperationStatus;
}
// @beta
export interface IWatchLoopOptions {
executeAsync: (state: IWatchLoopState) => Promise;
onAbort: () => void;
onBeforeExecute: () => void;
onRequestRun: OperationRequestRunCallback;
}
// @beta
export interface IWatchLoopState {
// (undocumented)
get abortSignal(): AbortSignal;
// (undocumented)
requestRun: OperationRequestRunCallback;
}
// @beta
export class Operation implements IOperationStates {
constructor(options: IOperationOptions);
// (undocumented)
addDependency(dependency: Operation): void;
readonly consumers: Set>;
criticalPathLength: number | undefined;
// (undocumented)
deleteDependency(dependency: Operation): void;
readonly dependencies: Set>;
// @internal (undocumented)
_executeAsync(context: IExecuteOperationContext): Promise;
readonly group: OperationGroupRecord | undefined;
lastState: IOperationState | undefined;
// (undocumented)
readonly metadata: TMetadata;
readonly name: string;
// (undocumented)
reset(): void;
runner: IOperationRunner | undefined;
state: IOperationState | undefined;
weight: number;
}
// @beta
export class OperationError extends Error {
constructor(type: string, message: string);
// (undocumented)
get message(): string;
// (undocumented)
toString(): string;
// (undocumented)
protected _type: string;
}
// @beta
export class OperationExecutionManager {
constructor(operations: ReadonlySet>);
executeAsync(executionOptions: IOperationExecutionOptions): Promise;
}
// @beta
export class OperationGroupRecord {
constructor(name: string, metadata?: TMetadata);
// (undocumented)
addOperation(operation: Operation): void;
// (undocumented)
get duration(): number;
// (undocumented)
get finished(): boolean;
// (undocumented)
get hasCancellations(): boolean;
// (undocumented)
get hasFailures(): boolean;
// (undocumented)
readonly metadata: TMetadata;
// (undocumented)
readonly name: string;
// (undocumented)
reset(): void;
// (undocumented)
setOperationAsComplete(operation: Operation, state: IOperationState): void;
// (undocumented)
startTimer(): void;
}
// @beta
export type OperationRequestRunCallback = (requestor: string, detail?: string) => void;
// @beta
export enum OperationStatus {
Aborted = "ABORTED",
Blocked = "BLOCKED",
Executing = "EXECUTING",
Failure = "FAILURE",
FromCache = "FROM CACHE",
NoOp = "NO OP",
Queued = "QUEUED",
Ready = "READY",
Skipped = "SKIPPED",
Success = "SUCCESS",
SuccessWithWarning = "SUCCESS WITH WARNINGS",
Waiting = "WAITING"
}
// @public
export class Stopwatch {
constructor();
get duration(): number;
get endTime(): number | undefined;
// (undocumented)
get isRunning(): boolean;
reset(): Stopwatch;
static start(): Stopwatch;
start(): Stopwatch;
get startTime(): number | undefined;
stop(): Stopwatch;
toString(): string;
}
// @beta
export class WatchLoop implements IWatchLoopState {
constructor(options: IWatchLoopOptions);
get abortSignal(): AbortSignal;
requestRun: OperationRequestRunCallback;
runIPCAsync(host?: IPCHost): Promise;
runUntilAbortedAsync(abortSignal: AbortSignal, onWaiting: () => void): Promise;
runUntilStableAsync(abortSignal: AbortSignal): Promise;
}
// (No @packageDocumentation comment for this package)
```