Interface SolveProgress

Thenable controller for a solve request.

Used to listen to events during solving, and can be awaited to retrieve the final solution/statistics/status.

Hierarchy

PromiseLike<SolveResult>
- SolveProgress

Index

Methods

cancel isRunning off on

Methods

cancel

cancel(): void

Cancel solving.

Returns void

Example

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

isRunning

isRunning(): boolean

Return whether or not solving is still in progress.

Returns boolean

Example

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

off

off<T>(event, callback): void

Stop listening for an event.

Type Parameters

Parameters

event: string
callback: ((e) => void)
- - (e): void
  - Parameters
    - e: T
    Returns void

Returns void

Example

const solve = model.solve({
  solver: 'gecode'
});
const onSolution = e => {
  console.log(e.output);
};
// Start listening
solve.on('solution', onSolution);
setTimeout(() => {
  // Stop listening
  solve.off('solution', onSolution);
}, 1000);

on

on(event, callback): void
Listen for an event.
Parameters
- event: "solution"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: SolutionMessage
      Returns void
Returns void
Example
```
const solve = model.solve({
  solver: 'gecode'
});
solve.on('solution', e => {
  console.log(e.output);
});
```
- Defined in index.d.ts:781
on(event, callback): void
Parameters
- event: "checker"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: CheckerMessage
      Returns void
Returns void
- Defined in index.d.ts:782
on(event, callback): void
Parameters
- event: "status"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: StatusMessage
      Returns void
Returns void
- Defined in index.d.ts:783
on(event, callback): void
Parameters
- event: "statistics"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: StatisticsMessage
      Returns void
Returns void
- Defined in index.d.ts:784
on(event, callback): void
Parameters
- event: "timestamp"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: TimestampMessage
      Returns void
Returns void
- Defined in index.d.ts:785
on(event, callback): void
Parameters
- event: "trace"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: TraceMessage
      Returns void
Returns void
- Defined in index.d.ts:786
on(event, callback): void
Parameters
- event: "error"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: ErrorMessage
      Returns void
Returns void
- Defined in index.d.ts:787
on(event, callback): void
Parameters
- event: "warning"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: WarningMessage
      Returns void
Returns void
- Defined in index.d.ts:788
on(event, callback): void
Parameters
- event: "exit"
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: ExitMessage
      Returns void
Returns void
- Defined in index.d.ts:789
on(event, callback): void
Parameters
- event: string
- callback: ((e) => void)
  - - (e): void
    - Parameters
      e: object
      Returns void
Returns void
- Defined in index.d.ts:790

Interface SolveProgress

Hierarchy

Index

Methods

Methods

cancel

Returns void

Example

isRunning

Returns boolean

Example

off

Type Parameters

T

Parameters

event: string

callback: ((e) => void)

Parameters

e: T

Returns void

Returns void

Example

on

Parameters

event: "solution"

callback: ((e) => void)

Parameters

e: SolutionMessage

Returns void

Returns void

Example

Parameters

event: "checker"

callback: ((e) => void)

Parameters

e: CheckerMessage

Returns void

Returns void

Parameters

event: "status"

callback: ((e) => void)

Parameters

e: StatusMessage

Returns void

Returns void

Parameters

event: "statistics"

callback: ((e) => void)

Parameters

e: StatisticsMessage

Returns void

Returns void

Parameters

event: "timestamp"

callback: ((e) => void)

Parameters

e: TimestampMessage

Returns void

Returns void

Parameters

event: "trace"

callback: ((e) => void)

Parameters

e: TraceMessage

Returns void

Returns void

Parameters

event: "error"

callback: ((e) => void)

Parameters

e: ErrorMessage

Returns void

Returns void

Parameters

event: "warning"

callback: ((e) => void)

Parameters

e: WarningMessage

Returns void

Returns void