tonal-notation - npm Package Compare versions

Comparing version 0.60.0 to 0.61.0

build/index.js

@@ -6,2 +6,17 @@ 'use strict';
 /**
+ * Functions related to music notation in strings. Things like parse accidentals,
+ * or convert from step to note letter.
+ *
+ * Glossary:
+ *
+ * - step: the number from 0 to 6 representing the letters from C to B
+ * - letter: a valid note letter (from A to G)
+ * - alteration: a number indicating the sharps (positive) or flats (negative)
+ * - accidentals: a string with sharps (#) or flats (b)
+ *
+ * @example
+ * var notation = require('tonal-notation')
+ * notation.toAcc('3') // => '###'
+ * notation.toAcc('-3') // => 'bbb'
+ * notation.toAlt('###') // => 3
  * @module notation
@@ -8,0 +23,0 @@ */

index.js

 /**
+ * Functions related to music notation in strings. Things like parse accidentals,
+ * or convert from step to note letter.
+ *
+ * Glossary:
+ *
+ * - step: the number from 0 to 6 representing the letters from C to B
+ * - letter: a valid note letter (from A to G)
+ * - alteration: a number indicating the sharps (positive) or flats (negative)
+ * - accidentals: a string with sharps (#) or flats (b)
+ *
+ * @example
+ * var notation = require('tonal-notation')
+ * notation.toAcc('3') // => '###'
+ * notation.toAcc('-3') // => 'bbb'
+ * notation.toAlt('###') // => 3
  * @module notation
@@ -3,0 +18,0 @@ */

package.json

 {
   "name": "tonal-notation",
-  "version": "0.60.0",
+  "version": "0.61.0",
   "description": "Music notation utilities",
@@ -10,3 +10,6 @@ "keywords": [
   ],
-  "scripts": {},
+  "scripts": {
+    "pretest": "rollup -f cjs -o build/index.js -- index.js",
+    "test": "tape test/*.js"
+  },
   "main": "build/index.js",
@@ -13,0 +16,0 @@ "jsnext:main": "index",

No alert changes

Improved metrics

Total package byte prevSize

11012

increased by12.32%

Lines of code

204

increased by17.24%

No dependency changes