Skip to content

API Reference


API Reference / CandidateRelation

Type Alias: CandidateRelation ​

ts
type CandidateRelation = "top" | "half" | "double" | "other";

Defined in: contract/types.ts:155

How a candidate's tempo relates to the reading's tempo. May grow in a minor release.

  • top: the reading's own tempo. Only candidates[0] has it.
  • half / double: half or twice the top tempo, within RELATION_TOLERANCE.
  • other: anything else, 3:2 relatives included.