tonal-pcset - npm Package Compare versions

Comparing version 0.69.7 to 0.69.8

package.json

 {
   "name": "tonal-pcset",
-  "version": "0.69.7",
+  "version": "0.69.8",
   "description": "Pitch class sets",
@@ -23,3 +23,3 @@ "keywords": [
     "tonal-array": "^0.69.7",
-    "tonal-note": "^0.69.7",
+    "tonal-note": "^0.69.8",
     "tonal-pitch": "^0.69.7",
@@ -26,0 +26,0 @@ "tonal-transpose": "^0.69.7"

README.md

@@ -28,3 +28,4 @@ <a name="module_pcset"></a>
     * [`.isChroma(chroma)`](#module_pcset.isChroma) ⇒ <code>Boolean</code>
-    * [`.fromChroma(binary, tonic)`](#module_pcset.fromChroma) ⇒ <code>Array</code>
+    * [`.intervals(pcset)`](#module_pcset.intervals) ⇒ <code>Array</code>
+    * ~~[`.fromChroma(binary, tonic)`](#module_pcset.fromChroma) ⇒ <code>Array</code>~~
     * [`.isEqual(set1, set2)`](#module_pcset.isEqual) ⇒ <code>Boolean</code>
@@ -45,3 +46,3 @@ * [`.isSubset(set, test)`](#module_pcset.isSubset) ⇒ <code>Boolean</code>
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>String</code> - a binary representation of the pitch class set  
@@ -51,3 +52,3 @@
 | --- | --- | --- |
-| set | <code>Array</code> &#124; <code>String</code> | the pitch class set |
+| set | <code>Array</code> \| <code>String</code> | the pitch class set |
 
@@ -63,3 +64,3 @@ **Example**
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Array</code> - an array of pitch class sets  
@@ -72,3 +73,3 @@ **See**: collection.pcset
 | --- | --- | --- |
-| notes | <code>String</code> &#124; <code>Array</code> | the pitch class set notes |
+| notes | <code>String</code> \| <code>Array</code> | the pitch class set notes |
 
@@ -83,3 +84,3 @@ <a name="module_pcset.modes"></a>
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Array.&lt;String&gt;</code> - an array with all the modes of the chroma  
@@ -89,3 +90,3 @@
 | --- | --- | --- |
-| set | <code>Array</code> &#124; <code>String</code> | the list of notes or pitchChr of the set |
+| set | <code>Array</code> \| <code>String</code> | the list of notes or pitchChr of the set |
 | normalize | <code>Boolean</code> | (Optional, true by default) remove all the rotations that starts with '0' |
@@ -102,3 +103,3 @@
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **See**: modes  
@@ -110,3 +111,3 @@ <a name="module_pcset.isChroma"></a>
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Boolean</code> - true if its a valid pcset chroma  
@@ -123,10 +124,28 @@
 ```
+<a name="module_pcset.intervals"></a>
+
+## `pcset.intervals(pcset)` ⇒ <code>Array</code>
+Given a pcset (notes or chroma) return it's intervals
+
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
+**Returns**: <code>Array</code> - intervals or empty array if not valid pcset  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| pcset | <code>String</code> \| <code>Array</code> | the pitch class set (notes or chroma) |
+
+**Example**  
+```js
+pcset.intervals('1010100000000') => ['C', 'D', 'E']
+```
 <a name="module_pcset.fromChroma"></a>
 
-## `pcset.fromChroma(binary, tonic)` ⇒ <code>Array</code>
-Given a pitch class set in binary notation it returns the intervals or notes
-(depending on the tonic)
+## ~~`pcset.fromChroma(binary, tonic)` ⇒ <code>Array</code>~~
+***Deprecated***
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Array</code> - a list of notes or intervals  
+**See**: intervals
+Given a pitch class set in binary notation it returns the intervals or notes
+(depending on the tonic)  
 
@@ -136,3 +155,3 @@ | Param | Type | Description |
 | binary | <code>String</code> | the pitch class set in binary representation |
-| tonic | <code>String</code> &#124; <code>Pitch</code> | the pitch class set tonic |
+| tonic | <code>String</code> \| <code>Pitch</code> | the pitch class set tonic |
 
@@ -148,3 +167,3 @@ **Example**
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Boolean</code> - true if they are equal  
@@ -154,4 +173,4 @@
 | --- | --- | --- |
-| set1 | <code>Array</code> &#124; <code>String</code> | one of the pitch class sets |
-| set2 | <code>Array</code> &#124; <code>String</code> | the other pitch class set |
+| set1 | <code>Array</code> \| <code>String</code> | one of the pitch class sets |
+| set2 | <code>Array</code> \| <code>String</code> | the other pitch class set |
 
@@ -167,3 +186,3 @@ **Example**
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Boolean</code> - true if the test set is a subset of the set  
@@ -173,4 +192,4 @@
 | --- | --- | --- |
-| set | <code>Array</code> &#124; <code>String</code> | the base set to test against |
-| test | <code>Array</code> &#124; <code>String</code> | the set to test |
+| set | <code>Array</code> \| <code>String</code> | the base set to test against |
+| test | <code>Array</code> \| <code>String</code> | the set to test |
 
@@ -186,3 +205,3 @@ **Example**
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Boolean</code> - true if the test set is a superset of the set  
@@ -192,4 +211,4 @@
 | --- | --- | --- |
-| set | <code>Array</code> &#124; <code>String</code> | the base set to test against |
-| test | <code>Array</code> &#124; <code>String</code> | the set to test |
+| set | <code>Array</code> \| <code>String</code> | the base set to test against |
+| test | <code>Array</code> \| <code>String</code> | the set to test |
 
@@ -205,3 +224,3 @@ **Example**
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Boolean</code> - true if the note is included in the pcset  
@@ -211,4 +230,4 @@
 | --- | --- | --- |
-| set | <code>Array</code> &#124; <code>String</code> | the base set to test against |
-| note | <code>String</code> &#124; <code>Pitch</code> | the note to test |
+| set | <code>Array</code> \| <code>String</code> | the base set to test against |
+| note | <code>String</code> \| <code>Pitch</code> | the note to test |
 
@@ -225,3 +244,3 @@ **Example**
 
-**Kind**: static method of <code>[pcset](#module_pcset)</code>  
+**Kind**: static method of [<code>pcset</code>](#module_pcset)  
 **Returns**: <code>Array</code> - the filtered notes  
@@ -231,4 +250,4 @@
 | --- | --- | --- |
-| set | <code>Array</code> &#124; <code>String</code> | the pitch class set notes |
-| notes | <code>Array</code> &#124; <code>String</code> | the note list to be filtered |
+| set | <code>Array</code> \| <code>String</code> | the pitch class set notes |
+| notes | <code>Array</code> \| <code>String</code> | the note list to be filtered |
 
@@ -235,0 +254,0 @@ **Example**

No alert changes

Improved metrics

Total package byte prevSize

105721

increased by0.55%

Number of lines in readme file

238

increased by8.68%

Dependency changes

• Updatedtonal-note@^0.69.8