Enumeration IntervalQuality

An interval quality distinguishes between major and minor intervals, and further augments or diminishes an interval.

See Wikipedia: Interval quality.

Index

Enumeration members

Functions

Enumeration members

Augmented

Augmented: = "A"

An augmented interval is widened by a chromatic semitone.

Diminished

Diminished: = "d"

A diminished interval is narrowed by a chromatic semitone.

DoublyAugmented

DoublyAugmented: = "AA"

DoublyDiminished

DoublyDiminished: = "dd"

Major

Major: = "M"

A major interval.

Minor

Minor: = "m"

A minor interval.

Perfect

Perfect: = "P"

Functions

add

add(a: IntervalQuality, b: IntervalQuality): IntervalQuality | null

- Defined in IntervalQuality.ts:131
Parameters
- a: IntervalQuality
- b: IntervalQuality
Returns IntervalQuality | null

augment

augment(q: IntervalQuality | null, perfect?: boolean): IntervalQuality | null

- Defined in IntervalQuality.ts:149
Parameters
- q: IntervalQuality | null
- Default value perfect: boolean = false
Returns IntervalQuality | null

closestNatural

closestNatural(q: IntervalQuality, isPerfect?: undefined | false | true): IntervalQuality

- Defined in IntervalQuality.ts:170
The closest major or minor quality.

Parameters
- q: IntervalQuality
- Optional isPerfect: undefined | false | true
Returns IntervalQuality

diminish

diminish(q: IntervalQuality | null, perfect?: boolean): IntervalQuality | null

- Defined in IntervalQuality.ts:156
Parameters
- q: IntervalQuality | null
- Default value perfect: boolean = false
Returns IntervalQuality | null

fromSemitones

fromSemitones(n: number, natural?: IntervalQuality): IntervalQuality | null

- Defined in IntervalQuality.ts:114
If n === 0, the value of natural is returned.

Parameters
- n: number
- Optional natural: IntervalQuality
Returns IntervalQuality | null

fromString

fromString(name: string): IntervalQuality | null

- Defined in IntervalQuality.ts:105
Parameters
- name: string
Returns IntervalQuality | null

inverse

inverse(q: IntervalQuality | null): IntervalQuality | null

- Defined in IntervalQuality.ts:163
Parameters
- q: IntervalQuality | null
Returns IntervalQuality | null

toSemitones

toSemitones(q: IntervalQuality | null): number

- Defined in IntervalQuality.ts:126
The signed distance in semitones from the diatonic note.

Note that Minor, Major, and Perfect all return 0.

Parameters
- q: IntervalQuality | null
Returns number

toString

toString(q: IntervalQuality, fullName?: boolean): string

- Defined in IntervalQuality.ts:109
Parameters
- q: IntervalQuality
- Default value fullName: boolean = false
Returns string

Generated using TypeDoc