UNPKG

tonal-detect

Version:

Find the name of pitch class sets

282 lines (281 loc) 8.24 kB
<!doctype html> <html lang="en"> <head> <title>Code coverage report for index.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="prettify.css" /> <link rel="stylesheet" href="base.css" /> <meta name="viewport" content="width=device-width, initial-scale=1"> <style type='text/css'> .coverage-summary .sorter { background-image: url(sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1> <a href="index.html">All files</a> index.js </h1> <div class='clearfix'> <div class='fl pad1y space-right2'> <span class="strong">93.33% </span> <span class="quiet">Statements</span> <span class='fraction'>14/15</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Branches</span> <span class='fraction'>6/6</span> </div> <div class='fl pad1y space-right2'> <span class="strong">85.71% </span> <span class="quiet">Functions</span> <span class='fraction'>6/7</span> </div> <div class='fl pad1y space-right2'> <span class="strong">100% </span> <span class="quiet">Lines</span> <span class='fraction'>14/14</span> </div> </div> </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73</td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-yes">4x</span> <span class="cline-any cline-yes">7x</span> <span class="cline-any cline-yes">7x</span> <span class="cline-any cline-yes">7x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">36x</span> <span class="cline-any cline-yes">36x</span> <span class="cline-any cline-yes">36x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">36x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">7x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">7x</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-neutral">&nbsp;</span> <span class="cline-any cline-yes">1x</span> <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">/** * [![npm version](https://img.shields.io/npm/v/tonal-detect.svg?style=flat-square)](https://www.npmjs.com/package/tonal-detect) * * Find chord and scale names from a collection of notes or pitch classes * * This is part of [tonal](https://www.npmjs.com/package/tonal) music theory library. * * @example * import { chord } from "tonal-detect" * chord(["C", "E", "G", "A"]) // =&gt; ["CM6", "Am7"] * * @example * const Detect = require("tonal-detect") * Detect.chord(["C", "E", "G", "A"]) // =&gt; ["CM6", "Am7"] * * @module Detect */ import { name, pc } from "tonal-note"; import * as Dictionary from "tonal-dictionary"; import { sort, compact } from "tonal-array"; import { modes } from "tonal-pcset"; &nbsp; export function detector(dictionary, defaultBuilder) { defaultBuilder = defaultBuilder || (<span class="fstat-no" title="function not covered" >(t</span>onic, names) =&gt; <span class="cstat-no" title="statement not covered" >[tonic, names])</span>; return function(notes, builder) { builder = builder || defaultBuilder; notes = sort(notes.map(pc)); return modes(notes) .map((mode, i) =&gt; { const tonic = name(notes[i]); const names = dictionary.names(mode); return names.length ? builder(tonic, names) : null; }) .filter(x =&gt; x); }; } &nbsp; /** * Given a collection of notes or pitch classes, try to find the chord name * @function * @param {Array&lt;String&gt;} notes * @return {Array&lt;String&gt;} chord names or empty array * @example * Detect.chord(["C", "E", "G", "A"]) // =&gt; ["CM6", "Am7"] */ export const chord = detector( Dictionary.chord, (tonic, names) =&gt; tonic + names[0] ); &nbsp; /** * Given a collection of notes or pitch classes, try to find the scale names * @function * @param {Array&lt;String&gt;} notes * @return {Array&lt;String&gt;} scale names or empty array * @example * Detect.scale(["f3", "a", "c5", "e2", "d", "g2", "b6"]) // =&gt; [ * "C major", * "D dorian", * "E phrygian", * "F lydian", * "G mixolydian", * "A aeolian", * "B locrian" * ] */ export const scale = detector( Dictionary.scale, (tonic, names) =&gt; tonic + " " + names[0] ); &nbsp; export const pcset = detector(Dictionary.pcset); &nbsp;</pre></td></tr> </table></pre> <div class='push'></div><!-- for sticky footer --> </div><!-- /wrapper --> <div class='footer quiet pad2 space-top1 center small'> Code coverage generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Feb 26 2019 22:01:05 GMT+0100 (CET) </div> </div> <script src="prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="sorter.js"></script> </body> </html>