Type Alias Highs

Type Declaration

• Readonlyconstants: HighsConstants

  Immutable numeric encodings accepted and returned by the API.

• Readonlyerrors: HighsErrorConstructors

  Error classes used by throwing persistent wrappers.

• Readonlyinfinity: number

  IEEE positive infinity returned by this build of HiGHS.

• ReadonlyintBits: number

  Width of native HighsInt; indices must fit this signed width.

• ReadonlyintBytes: number

  Native HighsInt width in bytes.

• ReadonlymemoryBytes: number

  Current Wasm linear-memory capacity, not the amount of live allocation.

• Readonlyraw: RawRuntimeApi

  Status-preserving APIs corresponding closely to the stable C API.

• Readonlyversion: HighsVersion

  Immutable version metadata for the loaded Wasm build.

• createModel: function

  • createModel(source?: ModelData | EncodedModel): SymbolDisposable<Model>

    Creates a persistent native instance and optionally loads copied structured data or parses in-memory LP/MPS content. Garbage collection does not release its native memory, so the caller must use Highs.withModel(), using, or eventually call dispose(). Failing to do so leaks Wasm memory for the lifetime of the runtime.

    Parameters

    • Optionalsource: ModelData | EncodedModel

    Returns SymbolDisposable<Model>

• withModel: function

  • withModel<Result>(
        operation: (model: SymbolDisposable<Model>) => PromiseLike<Result>,
    ): Promise<Result>

    Creates a model for the duration of operation and disposes it after the returned value, or after a returned Promise-like value settles. Do not retain or return the model itself: it is disposed when this method finishes.

    Type Parameters

    • Result

    Parameters

    • operation: (model: SymbolDisposable<Model>) => PromiseLike<Result>

    Returns Promise<Result>

  • withModel<Result>(operation: (model: SymbolDisposable<Model>) => Result): Result

    Synchronous withModel() overload.

    Type Parameters

    • Result

    Parameters

    • operation: (model: SymbolDisposable<Model>) => Result

    Returns Result

  • withModel<Result>(
        source: ModelData | EncodedModel,
        operation: (model: SymbolDisposable<Model>) => PromiseLike<Result>,
    ): Promise<Result>

    Creates a populated scoped model and awaits a Promise-like operation result.

    Type Parameters

    • Result

    Parameters

    • source: ModelData | EncodedModel
    • operation: (model: SymbolDisposable<Model>) => PromiseLike<Result>

    Returns Promise<Result>

  • withModel<Result>(
        source: ModelData | EncodedModel,
        operation: (model: SymbolDisposable<Model>) => Result,
    ): Result

    Creates a populated scoped model and returns a synchronous operation result.

    Type Parameters

    • Result

    Parameters

    • source: ModelData | EncodedModel
    • operation: (model: SymbolDisposable<Model>) => Result

    Returns Result