Interface CompilationProgress

Thenable controller for a compilation request.

Used to listen to events during compilation, and can be awaited to retrieve the compiled FlatZinc.

interface CompilationProgress {
    cancel(): void;
    isRunning(): boolean;
    off<T>(event: string, callback: (e: T) => void): void;
    on(event: "statistics", callback: (e: StatisticsMessage) => void): void;
    on(event: "trace", callback: (e: TraceMessage) => void): void;
    on(event: "error", callback: (e: ErrorMessage) => void): void;
    on(event: "warning", callback: (e: WarningMessage) => void): void;
    on(event: "exit", callback: (e: ExitMessage) => void): void;
    on(event: string, callback: (e: object) => void): void;
}

Hierarchy

  • PromiseLike<string>
    • CompilationProgress

Methods

cancel isRunning off on

Methods

cancel

  • cancel(): void

  • Cancel compilation.

    Returns void

    Example

    const compile = model.compile({
      options: {
        solver: 'gecode'
      }
    });
    setTimeout(() => {
      if (compile.isRunning()) {
        compile.cancel();
      }
    }, 10000);

isRunning

  • isRunning(): boolean

  • Return whether or not compilation is still in progress.

    Returns boolean

    Example

    const compile = model.compile({
      options: {
        solver: 'gecode'
      }
    });
    setInterval(() => {
      if (compile.isRunning()) {
        console.log('Still running');
      }
    }, 1000)

off

  • off<T>(event: string, callback: (e: T) => void): void

  • Stop listening for an event.

    Type Parameters

    • T

    Parameters

    • event: string
    • callback: (e: T) => void

    Returns void

    Example

    const compile = model.compile({
      solver: 'gecode',
      statistics: true
    });
    const onStat = e => {
      console.log(e.output);
    };
    // Start listening
    compile.on('statistics', onStat);
    setTimeout(() => {
      // Stop listening
      compile.off('statistics', onStat);
    }, 1000);

on

  • on(event: "statistics", callback: (e: StatisticsMessage) => void): void

  • Listen for an event.

    Parameters

    Returns void

    Example

    const compile = model.compile({
      solver: 'gecode',
      statistics: true
    });
    solve.on('statistics', e => {
      console.log(e.statistics);
    });
  • on(event: "trace", callback: (e: TraceMessage) => void): void

  • Parameters

    Returns void

  • on(event: "error", callback: (e: ErrorMessage) => void): void

  • Parameters

    Returns void

  • on(event: "warning", callback: (e: WarningMessage) => void): void

  • Parameters

    Returns void

  • on(event: "exit", callback: (e: ExitMessage) => void): void

  • Parameters

    Returns void

  • on(event: string, callback: (e: object) => void): void

  • Parameters

    • event: string
    • callback: (e: object) => void

    Returns void

Settings

Member Visibility

On This Page

Methods