pitch-sort

1.0.1 • Public • Published

pitch-sort npm version

tonal

Sort a collection of notes or intervals:

var sort = require('pitch-sort')
// true means ascending:
sort(true, 'c2 d5 f0 gb g#2 db-1 c# ab2 h6 b3')
// => [null, 'C#', 'Gb', 'Db-1', 'F0', 'C2', 'G#2', 'Ab2', 'B3', 'D5']

You can install it via npm: npm i --save pitch-sort

This function is part of tonal:

var tonal = require('tonal')
tonal.sort(true, 'A G F C E') // => ['C', 'E', 'F', 'G', 'A']
tonal.sort(false, 'A G F C E') // => ['A', 'G', 'F', 'E', 'C']
// tonal aliases
tonal.sortAsc('A G F C E') // => ['C', 'E', 'F', 'G', 'A']
tonal.sortDesc('A G F C E') // => ['A', 'G', 'F', 'E', 'C']

API: sort(comparator, source)

Sort a collection of notes or intervals. It can sort in ascending or descending pitch order or using a custom comparator.

This function is currified

Parameters

  • comparator Function or Boolean the comparator function, or true to sort in ascending pitch order and false to sort in descending pitch order
  • source String or Array the notes or intervals list

Examples

var sort = require('note-sorter')
sort(true, 'c5 d2 f4 D2') // => ['D2', 'D2', 'F4', 'C5']
sort(false, 'c5 d2 f4 D2') // => ['C5', 'F4', 'D2', 'D2']
 
// partially applied
var descending = sort(false)
descending('C D E F G') // => [ 'G', 'F', 'E', 'D', 'C' ]

Returns Array the notes or intervals sorted

License

MIT License

Package Sidebar

Install

npm i pitch-sort

Weekly Downloads

3

Version

1.0.1

License

MIT

Last publish

Collaborators

  • danigb