Class Key

Represents a key, such as Eb (symbol), #3 (numeric) or VII (numeral).

The only function considered public API is Key.distance

Implements

KeyProperties

Index

Methods

toString distance

Methods

toString

toString(
    __namedParameters?: {
        showMinor?: boolean;
        useUnicodeModifier?: boolean;
    },
): string
Returns a string representation of an object.
Parameters
- __namedParameters: { showMinor?: boolean; useUnicodeModifier?: boolean } = {}
Returns string
- Defined in key.ts:480

`Static`distance

distance(oneKey: string | Key, otherKey: string | Key): number
Calculates the distance in semitones between one key and another.
Parameters
- oneKey: string | Key
  the key
- otherKey: string | Key
  the other key
Returns number
the distance in semitones
- Defined in key.ts:245