tonal-scale

tonal-scale

tonal-scale is a collection of functions to create and manipulate music scales.

This is part of tonal music theory library.

You can install via npm: npm i --save tonal-scale

API Reference

build(source, tonic) ⇒ Array

Create scales by scale type or intervals and tonic. The returned scale is an array of notes (or intervals if you specify false as tonic)

This function is currified

names(aliases) ⇒ Array

Return the available scale names

get(name) ⇒ Array

Get scale notes from scale name

build(source, tonic) ⇒ Array

Create scales by scale type or intervals and tonic. The returned scale is an array of notes (or intervals if you specify false as tonic)

This function is currified

Kind: global function
Returns: Array - the scale notes

Param	Type	Description
source	String	the scale type, intervals or notes
tonic	String	the scale tonic (or false to get intervals)

Example

var scale = require('tonal.scale')
// get scale notes using type and tonic
scale.create('maj7', 'C2') // => ['C2', 'E2', 'G2', 'B2']
// get scale intervals (tonic false)
scale.create('maj7', false) // => ['1P', '3M', '5P', '7M']
// partially applied
const maj7 = scale.create('maj7')
maj7('C') // => ['C', 'E', 'G', 'B']
// create scale from intervals
scale.create('1 3 5 m7 m9', 'C') // => ['C', 'E', 'G', 'Bb', 'Db']

names(aliases) ⇒ Array

Return the available scale names

Kind: global function
Returns: Array - the scale names

Param	Type	Description
aliases	boolean	true to include aliases

Example

scaleNames() // => ['maj7', ...]

get(name) ⇒ Array

Get scale notes from scale name

Kind: global function
Returns: Array - the scale notes

Param	Type	Description
name	String	the scale name

Example

var scale = require('tonal-scale')
scale.get('C7') // => ['C', 'E', 'G', 'Bb']
scale.get('CMaj7') // => ['C', 'E', 'G', 'B']