tonal-interval
Advanced tools
Comparing version 1.0.0-1 to 1.0.0-pre2
@@ -1,4 +0,4 @@ | ||
"use strict"; | ||
'use strict'; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
@@ -5,0 +5,0 @@ /** |
{ | ||
"name": "tonal-interval", | ||
"version": "1.0.0-1", | ||
"version": "1.0.0-pre2", | ||
"description": "Music interval creation and manipulation", | ||
@@ -5,0 +5,0 @@ "repository": "https://github.com/danigb/tonal/packages/interval", |
@@ -190,2 +190,10 @@ <a name="module_interval"></a> | ||
The properties must contain a `num` *or* `step`, and `alt`: | ||
- num: the interval number | ||
- step: the interval step (overrides the num property) | ||
- alt: the interval alteration | ||
- oct: (Optional) the number of octaves | ||
- dir: (Optional) the direction | ||
**Kind**: static method of [<code>interval</code>](#module_interval) | ||
@@ -196,3 +204,3 @@ **Returns**: <code>String</code> - the interval name | ||
| --- | --- | --- | | ||
| props | <code>Object</code> | the interval property object - num: the interval number - alt: the interval alteration - oct: the number of octaves - dir: the direction | | ||
| props | <code>Object</code> | the interval property object | | ||
@@ -202,2 +210,3 @@ **Example** | ||
interval.build({ step: 1, alt: -1, oct: 0, dir: 1 }) // => "1d" | ||
interval.build({ num: 9, alt: -1 }) // => '9m' | ||
``` | ||
@@ -204,0 +213,0 @@ <a name="module_interval.simplify"></a> |
34769
268