highs-dx

README

highs-dx is offering a slightly improved developer experience when using HiGHS in a TypeScript environment. The one thing it adds on top of all of the wonderful things offered through highs-js is typesafe access to the variables of the solution. That means the TypeScript compiler will prevent you from referring to undefined variables in your model, and your IDE will give sensible completion for all the variables at your disposal.

Currently, this library is a drop-in replacement for highs-js. It works exactly the same; it just sprinkles some type fairy dust on top of it.

Usage

npm install highs-dx

This project exports a default function for creating an instance of Highs. You use it in exactly the same way as highs-js.

FAQ

Why is this a separate project?

It doesn't have to be, but there's no free ride. Adding typesafety to model variable references requires quite a bit of typescript magic, which might impact your compilation times. Also, it's not battletested yet: it might break with larger models. So, handle with care.

The parser doesn't seem very accurate. Why is that?

CPLEX lp is pretty forgiven, but as a consequence, the type structures required to exactly represent the AST and balancing that with the limitations of TypeScript resulted into models where TypeScript basically just gave up. As a consequence, I switched to a slightly different approach where I'm not exactly "parsing" the AST, but look for patterns. The results are fairly accurate at this stage, but I'm not making any guarantees it will work in all situations.

Changelog

0.2.0

Minor Changes

• 4e1694a: Added a test illustrating typesafe integration with highs-js

• e74af00: Switch from lp_solve syntax to CPLEX lp syntax

  Note that the new way of extracting variables is now less precise. The syntax of a CPLEX lp file is considerably more complicated than we were handling before. As a result, the "parser" is less precise. There might be oversights, and we have yet to test when TypeScript gives up.

• 4e1694a: Fixes an issue that caused the VariableNameOf type to be exported under the wrong name.

• 8f204e7: Rename the project from highs-ts to highs-dx

• 4e1694a: Adds a declaration file for the modified high-js types.

Patch Changes

• 4e1694a: Prevents the tests from getting exported