Type alias KosMultipleFutureAwareFull<T>

KosMultipleFutureAwareFull<T>: KosMultipleFutureAwareMinimal & MultipleFutureProperties<T> & {
    progress: number;
    status: string;
    isRunning: boolean;
    isCancelled: boolean;
    cancelFuture(): Promise<void>;
}

Interface for models using

Type Parameters

  • T extends string = string

Type declaration

  • progress: number

    Current operation progress as a percentage (0-100) for the default future. Returns 0 when no default Future is active. Updates automatically as the Future operation progresses via WebSocket events.

  • status: string

    Current operation status string representation for the default future. Common values: "IDLE", "IN_PROGRESS", "SUCCESS", "ERROR", "CANCELLED". Returns "IDLE" when no default Future is active.

  • isRunning: boolean

    Whether the default operation is currently actively executing. True when default Future exists and has not reached an end state. False when no Future exists or operation has completed/failed/cancelled.

  • isCancelled: boolean

    Whether the current or most recent default operation was cancelled. Remains true after cancellation for status tracking until a new operation starts. False if operation completed normally or failed.

  • cancelFuture:function
    • cancelFuture(): Promise<void>

    • Cancels the currently running default Future operation. Sends cancellation request to the backend service managing the Future. No-op if no default Future is currently active.

      Returns Promise<void>

      Promise that resolves when cancellation is acknowledged

      Throws

      Error if cancellation request fails

Kos Multiple Future Aware

in full mode (default). Use TypeScript interface merging to add all Future Container properties and named futures to your model class.

Example

Add ESLint disable comment at top of file, then:

interface IceAgitatorModelImpl extends KosMultipleFutureAwareFull<"pour" | "agitate" | "gate"> {}

@kosMultipleFutureAware() // defaults to full mode
class IceAgitatorModelImpl implements IKosDataModel {
  // All Future Container properties and named futures are now available automatically
  // Access: this.pourFuture, this.agitateFuture, this.gateFuture

  onFutureUpdate?(future: IFutureModel): void {
    // Handle updates from any managed Future
  }
}

Settings

Member Visibility

Theme