Skip to main content

Function: mergeParameters()

mergeParameters(base: Parameters, overrides: Parameters): Parameters

Merges two Parameters settings into a new one.

Parameters

ParameterTypeDescription
baseParametersBase parameters that can be overridden
overridesParametersParameters that will overwrite values from base

Returns

Parameters

The merged parameters object

Remarks

The new object contains all parameters from both inputs. If the same parameter is specified in both input objects, then the value from overrides is used.

Input objects are not modified.

import * as cp from "@scheduleopt/optalcp";

const defaults: cp.Parameters = { timeLimit: 60, nbWorkers: 4 };
const overrides: cp.Parameters = { timeLimit: 120 };
const merged = cp.mergeParameters(defaults, overrides);
// merged = { timeLimit: 120, nbWorkers: 4 }