tonal-key - npm Package Compare versions

Comparing version 0.67.0 to 0.68.0

build/index.js

@@ -23,3 +23,4 @@ 'use strict';
 /**
- * Get scale of a key
+ * Get scale of a key (with optionally a mode)
+ *
  * @param {String|Object} key
@@ -41,7 +42,10 @@ * @return {Array} the key scale
 /**
- * Get relative of a key. It can be partially applied.
+ * Get relative of a key. Two keys are relative when the have the same
+ * key signature (for example C major and A minor)
+ *
+ * It can be partially applied.
+ *
  * @param {String} mode - the relative destination
  * @param {String} key - the key source
  * @example
- * var key = require('tonal-keys')
  * key.relative('dorian', 'C major') // => ['dorian', 'D']
@@ -48,0 +52,0 @@ * // partially application

index.js

 /**
- * A collection of functions related to music keys. Things like keys signatures,
- * scales, modes, etc.
+ * _Key_ refers to the tonal system based on the major and minor scales. This is
+ * is the most common tonal system, but tonality can be present in music
+ * based in other scales or concepts.
  *
+ * This is a collection of functions related to keys.
+ *
  * @example
@@ -9,2 +12,3 @@ * var key = require('tonal-key')
  * key.relative('minor', 'C major') // => ['minor', 'A']
+ *
  * @module key
@@ -31,3 +35,4 @@ */
 /**
- * Get scale of a key
+ * Get scale of a key (with optionally a mode)
+ *
  * @param {String|Object} key
@@ -49,7 +54,10 @@ * @return {Array} the key scale
 /**
- * Get relative of a key. It can be partially applied.
+ * Get relative of a key. Two keys are relative when the have the same
+ * key signature (for example C major and A minor)
+ *
+ * It can be partially applied.
+ *
  * @param {String} mode - the relative destination
  * @param {String} key - the key source
  * @example
- * var key = require('tonal-keys')
  * key.relative('dorian', 'C major') // => ['dorian', 'D']
@@ -56,0 +64,0 @@ * // partially application

package.json

 {
   "name": "tonal-key",
-  "version": "0.67.0",
+  "version": "0.68.0",
   "description": "Conversion between key numbers and note names",
@@ -23,7 +23,7 @@ "repository": "https://github.com/danigb/tonal/packages/key",
     "tonal-transpose": "^0.66.0",
-    "tonal-note": "^0.67.0",
-    "tonal-array": "^0.66.0",
-    "tonal-harmonizer": "^0.66.0",
-    "tonal-range": "^0.67.0"
+    "tonal-note": "^0.68.0",
+    "tonal-array": "^0.68.0",
+    "tonal-harmonizer": "^0.68.0",
+    "tonal-range": "^0.68.0"
   }
 }

No alert changes

Improved metrics

Total package byte prevSize

24776

increased by1.41%

Lines of code

507

increased by2.42%

Dependency changes

• + Addedtonal-array@0.68.0(transitive)

• + Addedtonal-freq@0.61.00.68.1(transitive)

• + Addedtonal-harmonizer@0.68.1(transitive)

• + Addedtonal-midi@0.61.00.68.1(transitive)

• + Addedtonal-note@0.66.00.68.1(transitive)

• + Addedtonal-pcset@0.68.1(transitive)

• + Addedtonal-range@0.68.1(transitive)

• - Removedtonal-array@0.66.0(transitive)

• - Removedtonal-freq@0.67.0(transitive)

• - Removedtonal-harmonizer@0.66.0(transitive)

• - Removedtonal-midi@0.66.0(transitive)

• - Removedtonal-note@0.67.0(transitive)

• - Removedtonal-pitchset@0.67.0(transitive)

• - Removedtonal-range@0.67.0(transitive)

• Updatedtonal-array@^0.68.0

• Updatedtonal-harmonizer@^0.68.0

• Updatedtonal-note@^0.68.0

• Updatedtonal-range@^0.68.0