tonal-distance

tonal-distance

tonal-distance is a collection of functions to find distances between music notes.

This is part of tonal music theory library.

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

API Reference

interval(from, to) ⇒ Interval

Find distance between two pitches. Both pitches MUST be of the same type. Distances between pitch classes always returns ascending intervals. Distances between intervals substract one from the other.

distance()

An alias for distance

interval(from, to) ⇒ Interval

Find distance between two pitches. Both pitches MUST be of the same type. Distances between pitch classes always returns ascending intervals. Distances between intervals substract one from the other.

Kind: global function
Returns: Interval - the distance between pitches

Param	Type	Description
from	Pitch | String	distance from
to	Pitch | String	distance to

Example

var tonal = require('tonal')
tonal.distance('C2', 'C3') // => 'P8'
tonal.distance('G', 'B') // => 'M3'
tonal.distance('M2', 'P5') // => 'P4'

distance()

An alias for distance

Kind: global function