highs-js API reference
    Preparing search index...

    Interface OptionStore

    Option facade bound to one persistent native instance. Exact snake_case names are discoverable with names() and describe(). Changes affect subsequent operations on this model only; bulk and text-based changes are not transactional, so earlier accepted settings remain if a later one fails.

    interface OptionStore {
        describe(name: string): OptionDescriptor;
        export(deviationsOnly?: boolean): string;
        get(name: string): OptionValue;
        names(): readonly string[];
        read(text: string): CallMetadata;
        reset(): CallMetadata;
        set(name: string, value: OptionValue): CallMetadata;
        set(values: Readonly<Record<string, OptionValue>>): CallMetadata;
    }
    Index
    describe export get names read reset set

    • Serializes all options, or only deviations, to detached text without exposing a path.

      Parameters

      • OptionaldeviationsOnly: boolean

      Returns string

    • Returns detached option names in native zero-based enumeration order.

      Returns readonly string[]

    • Parses option-file text privately; settings processed before an error may remain applied.

      Parameters

      • text: string

      Returns CallMetadata

    • Exact snake_case HiGHS option names. Thread/concurrency and file/path options throw HighsUnsupportedOptionError in this new API. Values are validated and copied synchronously. Native warnings are retained in the returned metadata; native errors throw HighsError.

      Parameters

      Returns CallMetadata

    • Sets several options in property enumeration order; earlier changes remain if a later set fails.

      Parameters

      Returns CallMetadata

    Settings
    Member Visibility

    On This Page
    Methods