tonal-key

Key

tonal-key is a collection of functions to query about tonal keys.

This is part of tonal music theory library.

Example

// es6
import * as Key from "tonal-key"
// es5
const Key = require("tonal-key")

Example

Key.scale("E mixolydian") // => [ "E", "F#", "G#", "A", "B", "C#", "D" ]
Key.relative("minor", "C major") // => "A minor"

• Key
  • .degrees ⇒ Array
  • .modeNames(alias) ⇒ Array
  • .fromAlter(alt) ⇒ Key
  • .props(name) ⇒ Object
  • .scale(key) ⇒ Array
  • .alteredNotes(key) ⇒ Array
  • .chords(name) ⇒ Array
  • .secDomChords(name) ⇒ Array
  • .relative(mode, key)
  • .tokenize(name) ⇒ Array

Key.degrees ⇒ Array

Get a list of key scale degrees

Kind: static constant of Key

Param	Type
keyName	String

Example

Key.degrees("C major") => ["I", "ii", "iii", "IV", "V", "vi", "vii"]

Key.modeNames(alias) ⇒ Array

Get a list of valid mode names. The list of modes will be always in increasing order (ionian to locrian)

Kind: static method of Key
Returns: Array - an array of strings

Param	Type	Description
alias	Boolean	true to get aliases names

Example

Key.modes() // => [ "ionian", "dorian", "phrygian", "lydian",
// "mixolydian", "aeolian", "locrian" ]
Key.modes(true) // => [ "ionian", "dorian", "phrygian", "lydian",
// "mixolydian", "aeolian", "locrian", "major", "minor" ]

Key.fromAlter(alt) ⇒ Key

Create a major key from alterations

Kind: static method of Key
Returns: Key - the key object

Param	Type	Description
alt	Integer	the alteration number (positive sharps, negative flats)

Example

Key.fromAlter(2) // => "D major"

Key.props(name) ⇒ Object

Return the a key properties object with the following information:

• name {String}: name
• tonic {String}: key tonic
• mode {String}: key mode
• modenum {Number}: mode number (0 major, 1 dorian, ...)
• intervals {Array}: the scale intervals
• scale {Array}: the scale notes
• acc {String}: accidentals of the key signature
• alt {Number}: alteration number (a numeric representation of accidentals)

Kind: static method of Key
Returns: Object - the key properties object or null if not a valid key

Param	Type	Description
name	String	the key name

Example

Key.props("C3 dorian") // => { tonic: "C", mode: "dorian", ... }

Key.scale(key) ⇒ Array

Get scale of a key

Kind: static method of Key
Returns: Array - the key scale

Param	Type
key	String | Object

Example

Key.scale("A major") // => [ "A", "B", "C#", "D", "E", "F#", "G#" ]
Key.scale("Bb minor") // => [ "Bb", "C", "Db", "Eb", "F", "Gb", "Ab" ]
Key.scale("C dorian") // => [ "C", "D", "Eb", "F", "G", "A", "Bb" ]
Key.scale("E mixolydian") // => [ "E", "F#", "G#", "A", "B", "C#", "D" ]

Key.alteredNotes(key) ⇒ Array

Get a list of the altered notes of a given Key. The notes will be in the same order than in the key signature.

Kind: static method of Key

Param	Type	Description
key	String	the key name

Example

Key.alteredNotes("Eb major") // => [ "Bb", "Eb", "Ab" ]

Key.chords(name) ⇒ Array

Get key chords

Kind: static method of Key

Param	Type	Description
name	String	the key name

Example

Key.chords("A major") // => ["AMaj7", "Bm7", "C#m7", "DMaj7", ..,]

Key.secDomChords(name) ⇒ Array

Get secondary dominant key chords

Kind: static method of Key

Param	Type	Description
name	String	the key name

Example

Key.secDomChords("A major") // => ["E7", "F#7", ...]

Key.relative(mode, key)

Get relative of a key. Two keys are relative when the have the same key signature (for example C major and A minor)

It can be partially applied.

Kind: static method of Key

Param	Type	Description
mode	String	the relative destination
key	String	the key source

Example

Key.relative("dorian", "B major") // => "C# dorian"
// partial application
var minor = Key.relative("minor")
minor("C major") // => "A minor"
minor("E major") // => "C# minor"

Key.tokenize(name) ⇒ Array

Split the key name into its components (pitch class tonic and mode name)

Kind: static method of Key
Returns: Array - an array in the form [tonic, key]

Param	Type
name	String

Example

Key.tokenize("C major") // => ["C", "major"]