tone-rhythm/CHANGELOG.md

Generate an array of Tone.Transport times for use in Tone.Part

# Changelog

## v2.0.0 [MAJOR]

Fix: Dependencies are evaluated only once instead of every function call.

Fix / BREAKING CHANGE: The `toneRhythm` function is no longer the default export. This should make mocking/stubbing easier:

```js
const { toneRhythm } = require('tone-rhythm');
```

Fix: Documentation for instantiation. Calling the function in the same line as the `require` statement made requiring the module difficult in a no-dom testing environment.

```js
// previously was const toneRhythm = require('tone-rhythm')(()=>{})
const { toneRhythm } = require('tone-rhythm');

// destructure only the functions needed:
const {
    getBarsBeats,
    addTimes,
    getTransportTimes,
    mergeMusicDataPart,
  } = toneRhythm(Tone.Time)
```

## v1.2.0 [MINOR] Apr 20, 2019

Fix/Feature: Allow instantiation if tone-rhythm without throwing an error. Error will be thrown at run-time if Tone.Time is passed in incorrectly:

```js
const toneRhythm = require('tone-rhythm')(()=>{}); // doesn't throw error
toneRhythm.mergeMusicDataPart({ /* data */}); // throws error
```

## v1.1.0 [MINOR] Apr 13, 2019

Feature: Add `idx` property to return of `mergeMusicDataPart`. `idx` is exactly equal to the array index in the returned data:

```js
const mergedData = mergeMusicDataPart({
    rhythms: mariaDurations
});
// mergedData[0]:
// {
//     duration: '8n',
//     idx: 0,
//     time: 0
// };
```

## v1.0.0 [MAJOR] Apr 9, 2019

BREAKING CHANGE - Tone is now a true "peer dependency" and needs to be included in the toneRhythm factory function:

```js
const ToneTime = require('tone/Tone/type/Time');
const toneRhythm = require('tone-rhythm')(ToneTime);
const {
    getBarsBeats,
    addTimes,
    getTransportTimes,
    mergeMusicDataPart
} = toneRhythm;
```

This is to prevent possible conflicts between versions of tone bundled in tone-rhythm pre-version 1.0.0.

## v0.0.2

(Legacy) Pre-bundled with Tone 0.12.8

See [docs/tone-rhythm@0.0.2.md](docs/tone-rhythm@0.0.2.md).