Skip to main content

Type Alias: AdcSystemSelectorOptions

AdcSystemSelectorOptions = object

Defined in: src/garminsdk/system/AdcSystemSelector.ts:20

Configuration options for AdcSystemSelector.

Properties

desirabilityComparator()?

optional desirabilityComparator: (a, b) => number

Defined in: src/garminsdk/system/AdcSystemSelector.ts:37

A function that compares the desirability of two ADC systems.

Parameters

ParameterTypeDescription
aAdcSystemSelectionStateThe state of the first ADC system.
bAdcSystemSelectionStateThe state of the second ADC system.

Returns

number

A number representing the relative desirability of the two ADC systems: -1 if system a is more desirable than b, 1 if system b is more desirable than a, and 0 if both are equally desirable.


systemPriorities?

optional systemPriorities: readonly number[] | ReadonlyMap<number, number> | SubscribableMap<number, number>

Defined in: src/garminsdk/system/AdcSystemSelector.ts:28

The priorities for selecting individual ADC systems. If two systems have the same desirability, then the one with the higher priority will be selected. If a system's priority is not defined, then it will default to a value of 0. The priorities can be specified as an array of ADC system indexes or a map of ADC system indexes to the priorities for selecting those systems. If specified as an array of indexes, then each system whose index appears in the array will be assigned a priority equal to array.length - array.indexOf(index).