tone 14.8.48 → 14.9.0

package/README.md

@@ -1,7 +1,7 @@
 Tone.js
 =========
 
-[![Build Status](https://travis-ci.com/Tonejs/Tone.js.svg?branch=dev)](https://app.travis-ci.com/github/Tonejs/Tone.js) [![codecov](https://codecov.io/gh/Tonejs/Tone.js/branch/dev/graph/badge.svg)](https://codecov.io/gh/Tonejs/Tone.js)
+[![codecov](https://codecov.io/gh/Tonejs/Tone.js/branch/dev/graph/badge.svg)](https://codecov.io/gh/Tonejs/Tone.js)
 
 
 Tone.js is a Web Audio framework for creating interactive music in the browser. The architecture of Tone.js aims to be familiar to both musicians and audio programmers creating web-based audio applications. On the high-level, Tone offers common DAW (digital audio workstation) features like a global transport for synchronizing and scheduling events as well as prebuilt synths and effects. Additionally, Tone provides high-performance building blocks to create your own synthesizers, effects, and complex control signals.
@@ -12,7 +12,7 @@ Tone.js is a Web Audio framework for creating interactive music in the browser.
 
 # Installation
 
-There are two ways to incorporate Tone.js into a proejct. First, it can be installed locally into a project using `npm`:
+There are two ways to incorporate Tone.js into a project. First, it can be installed locally into a project using `npm`:
 
 ```bash
 npm install tone      // Install the latest stable version

package/Tone/component/analysis/FFT.ts

@@ -13,6 +13,7 @@ export interface FFTOptions extends MeterBaseOptions {
 
 /**
  * Get the current frequency data of the connected audio source using a fast Fourier transform.
+ * Read more about FFT algorithms on [Wikipedia] (https://en.wikipedia.org/wiki/Fast_Fourier_transform).
  * @category Component
  */
 export class FFT extends MeterBase<FFTOptions> {

package/Tone/component/analysis/Meter.ts

@@ -103,7 +103,7 @@ export class Meter extends MeterBase<MeterOptions> {
 			const rms = Math.sqrt(totalSquared / values.length);
 			// the rms can only fall at the rate of the smoothing
 			// but can jump up instantly
-			this._rms[index] = Math.max(rms, this._rms[index]  * this.smoothing);
+			this._rms[index] = Math.max(rms, this._rms[index] * this.smoothing);
 			return this.normalRange ? this._rms[index] : gainToDb(this._rms[index]);
 		});
 		if (this.channels === 1) {

package/Tone/component/channel/Channel.ts

@@ -91,7 +91,7 @@ export class Channel extends ToneAudioNode<ChannelOptions> {
 	}
 
 	/**
-	 * Solo/unsolo the channel. Soloing is only relative to other [[Channels]] and [[Solo]] instances
+	 * Solo/unsolo the channel. Soloing is only relative to other [[Channel]]s and [[Solo]] instances
 	 */
 	get solo(): boolean {
 		return this._solo.solo;

package/Tone/core/clock/TickSource.ts

@@ -200,7 +200,7 @@ export class TickSource<TypeName extends "bpm" | "hertz"> extends ToneWithContex
 			if (lastState.state === "started" && e.state !== "started") {
 				elapsedTicks += this.frequency.getTicksAtTime(e.time) - this.frequency.getTicksAtTime(periodStartTime);
 				// do not memoize the temporary event
-				if (e.time != tmpEvent.time) {
+				if (e.time !== tmpEvent.time) {
 					eventToMemoize = { state: e.state, time: e.time, ticks: elapsedTicks };
 				}
 			}
@@ -275,7 +275,7 @@ export class TickSource<TypeName extends "bpm" | "hertz"> extends ToneWithContex
 			if (lastState.state === "started" && e.state !== "started") {
 				elapsedSeconds += e.time - periodStartTime;
 				// do not memoize the temporary event
-				if (e.time != tmpEvent.time) {
+				if (e.time !== tmpEvent.time) {
 					eventToMemoize = { state: e.state, time: e.time, seconds: elapsedSeconds };
 				}
 			}

package/Tone/core/clock/Ticker.ts

@@ -42,7 +42,7 @@ export class Ticker {
 
 		this._callback = callback;
 		this._type = type;
-		this._minimumUpdateInterval = Math.max( 128/(contextSampleRate || 44100), .001 );
+		this._minimumUpdateInterval = Math.max(128/(contextSampleRate || 44100), .001);
 		this.updateInterval = updateInterval;
 
 		// create the clock source for the first time

package/Tone/core/context/Context.ts

@@ -475,7 +475,7 @@ export class Context extends BaseContext {
 
 	/**
 	 * Starts the audio context from a suspended state. This is required
-	 * to initially start the AudioContext. See [[Tone.start]]
+	 * to initially start the AudioContext. See [[start]]
 	 */
 	resume(): Promise<void> {
 		if (isAudioContext(this._context)) {

package/Tone/core/context/ToneAudioBuffer.ts

@@ -397,9 +397,9 @@ export class ToneAudioBuffer extends Tone {
 		const location = document.createElement("a");
 		location.href = baseUrl + url;
 		location.pathname = (location.pathname + location.hash)
-			.split("/")
-			.map(encodeURIComponent)
-			.join("/");
+				.split("/")
+				.map(encodeURIComponent)
+				.join("/");
 
 		const response = await fetch(location.href);
 		if (!response.ok) {
@@ -425,8 +425,8 @@ export class ToneAudioBuffer extends Tone {
 		const extensions = url.split(".");
 		const extension = extensions[extensions.length - 1];
 		const response = document
-			.createElement("audio")
-			.canPlayType("audio/" + extension);
+				.createElement("audio")
+				.canPlayType("audio/" + extension);
 		return response !== "";
 	}
 

package/Tone/core/context/ToneAudioNode.ts

@@ -385,7 +385,7 @@ export function disconnect(
  * const player1 = new Tone.Player("https://tonejs.github.io/audio/drum-samples/conga-rhythm.mp3");
  * const filter = new Tone.Filter("G5").toDestination();
  * // connect nodes to a common destination
- * fanIn(player, player1, filter);
+ * Tone.fanIn(player, player1, filter);
  */
 export function fanIn(...nodes: OutputNode[]): void {
 	const dstNode = nodes.pop();

package/Tone/core/context/ToneWithContext.ts

@@ -97,7 +97,7 @@ export abstract class ToneWithContext<Options extends ToneWithContextOptions> ex
 
 	/**
 	 * Convert the incoming time to seconds. 
-	 * This is calculated against the current [[Tone.Transport]] bpm
+	 * This is calculated against the current [[Transport]] bpm
 	 * @example
 	 * const gain = new Tone.Gain();
 	 * setInterval(() => console.log(gain.toSeconds("4n")), 100);

package/Tone/core/type/Frequency.ts

@@ -1,3 +1,4 @@
+/* eslint-disable key-spacing */
 import { getContext } from "../Global";
 import { intervalToFrequencyRatio, mtof } from "./Conversions";
 import { ftom, getA4, setA4 } from "./Conversions";
@@ -215,7 +216,7 @@ export class FrequencyClass<Type extends number = Hertz> extends TimeClass<Type,
 //-------------------------------------
 
 /**
- * Note to scale index. 
+ * Note to scale index.
  * @hidden
  */
 const noteToScaleIndex = {

package/Tone/effect/Chorus.test.ts

@@ -15,8 +15,8 @@ describe("Chorus", () => {
 			() => {
 				const chorus = new Chorus().toDestination().start();
 				const osc = new Oscillator(220, "sawtooth")
-					.connect(chorus)
-					.start();
+						.connect(chorus)
+						.start();
 			},
 			"chorus.wav",
 			0.25

package/Tone/effect/Chorus.ts

@@ -17,15 +17,15 @@ export interface ChorusOptions extends StereoFeedbackEffectOptions {
 
 /**
  * Chorus is a stereo chorus effect composed of a left and right delay with an [[LFO]] applied to the delayTime of each channel.
- * When [[feedback]] is set to a value larger than 0, you also get Flanger-type effects. 
+ * When [[feedback]] is set to a value larger than 0, you also get Flanger-type effects.
  * Inspiration from [Tuna.js](https://github.com/Dinahmoe/tuna/blob/master/tuna.js).
- * Read more on the chorus effect on [SoundOnSound](http://www.soundonsound.com/sos/jun04/articles/synthsecrets.htm).
+ * Read more on the chorus effect on [Sound On Sound](http://www.soundonsound.com/sos/jun04/articles/synthsecrets.htm).
  *
  * @example
  * const chorus = new Tone.Chorus(4, 2.5, 0.5).toDestination().start();
  * const synth = new Tone.PolySynth().connect(chorus);
  * synth.triggerAttackRelease(["C3", "E3", "G3"], "8n");
- * 
+ *
  * @category Effect
  */
 export class Chorus extends StereoFeedbackEffect<ChorusOptions> {

package/Tone/effect/Distortion.ts

@@ -10,7 +10,7 @@ export interface DistortionOptions extends EffectOptions {
 /**
  * A simple distortion effect using Tone.WaveShaper.
  * Algorithm from [this stackoverflow answer](http://stackoverflow.com/a/22313408).
- *
+ * Read more about distortion on [Wikipedia] (https://en.wikipedia.org/wiki/Distortion_(music)).
  * @example
  * const dist = new Tone.Distortion(0.8).toDestination();
  * const fm = new Tone.FMSynth().connect(dist);

package/Tone/event/Loop.ts

@@ -58,7 +58,8 @@ export class Loop<Options extends LoopOptions = LoopOptions> extends ToneWithCon
 			loop: true,
 			loopEnd: options.interval,
 			playbackRate: options.playbackRate,
-			probability: options.probability
+			probability: options.probability,
+			humanize: options.humanize,
 		});
 
 		this.callback = options.callback;

package/Tone/fromContext.ts

@@ -32,7 +32,7 @@ type ToneObject = {
  * Bind the TimeBaseClass to the context
  */
 function bindTypeClass(context: Context, type) {
-	return (...args: any[]) => new type(context, ...args);
+	return (...args: unknown[]) => new type(context, ...args);
 }
 
 /**

package/Tone/instrument/DuoSynth.ts

@@ -18,7 +18,7 @@ export interface DuoSynthOptions extends MonophonicOptions {
 }
 
 /**
- * DuoSynth is a monophonic synth composed of two [[MonoSynths]] run in parallel with control over the
+ * DuoSynth is a monophonic synth composed of two [[MonoSynth]]s run in parallel with control over the
  * frequency ratio between the two voices and vibrato effect.
  * @example
  * const duoSynth = new Tone.DuoSynth().toDestination();

package/Tone/instrument/PolySynth.ts

@@ -285,7 +285,6 @@ export class PolySynth<Voice extends Monophonic<any> = Synth> extends Instrument
 	 * @param  notes The notes to play. Accepts a single Frequency or an array of frequencies.
 	 * @param  time  When the release will be triggered.
 	 * @example
-	 * @example
 	 * const poly = new Tone.PolySynth(Tone.AMSynth).toDestination();
 	 * poly.triggerAttack(["Ab3", "C4", "F5"]);
 	 * // trigger the release of the given notes.

package/Tone/source/buffer/Player.test.ts

@@ -502,9 +502,9 @@ describe("Player", () => {
 				const player = new Player(buffer);
 				player.toDestination();
 				player
-					.start(0, 0, 0.05)
-					.start(0.1, 0, 0.05)
-					.start(0.2, 0, 0.05);
+						.start(0, 0, 0.05)
+						.start(0.1, 0, 0.05)
+						.start(0.2, 0, 0.05);
 				player.stop(0.1);
 			}, 0.3).then((buff) => {
 				expect(buff.getTimeOfLastSound()).to.be.closeTo(0.1, 0.02);
@@ -559,9 +559,9 @@ describe("Player", () => {
 		it("plays synced to the Transport", () => {
 			return Offline(({ transport }) => {
 				const player = new Player(buffer)
-					.sync()
-					.start(0)
-					.toDestination();
+						.sync()
+						.start(0)
+						.toDestination();
 				transport.start(0);
 			}, 0.05).then((buff) => {
 				expect(buff.isSilent()).to.be.false;
@@ -587,13 +587,13 @@ describe("Player", () => {
 		it("offsets correctly when started by the Transport", () => {
 			const testSample =
 				buffer.toArray(0)[
-					Math.floor(0.13125 * getContext().sampleRate)
+						Math.floor(0.13125 * getContext().sampleRate)
 				];
 			return Offline(({ transport }) => {
 				const player = new Player(buffer)
-					.sync()
-					.start(0, 0.1)
-					.toDestination();
+						.sync()
+						.start(0, 0.1)
+						.toDestination();
 				transport.start(0, 0.03125);
 			}, 0.05).then((buff) => {
 				expect(buff.toArray()[0][0]).to.equal(testSample);
@@ -709,12 +709,15 @@ describe("Player", () => {
 					setTimeout(() => {
 						player.restart(undefined, undefined, 1);
 						const checkStopTimes = new Set();
-						player["_activeSources"].forEach(source => {
-							checkStopTimes.add(source["_stopTime"]);
+						// @ts-ignore
+						player._activeSources.forEach(source => {
+							// @ts-ignore
+							checkStopTimes.add(source._stopTime);
 						});
 						getContext().lookAhead = originalLookAhead;
 						// ensure each source has a different stopTime
-						expect(checkStopTimes.size).to.equal(player["_activeSources"].size);
+						// @ts-ignore
+						expect(checkStopTimes.size).to.equal(player._activeSources.size);
 						done();
 					}, 250);
 				},

package/Tone/source/buffer/Players.ts

@@ -206,7 +206,7 @@ export class Players extends ToneAudioNode<PlayersOptions> {
 	 * const players = new Tone.Players();
 	 * players.add("gong", "https://tonejs.github.io/audio/berklee/gong_1.mp3", () => {
 	 * 	console.log("gong loaded");
-	 * 	players.get("gong").start();
+	 * 	players.player("gong").start();
 	 * });
 	 */
 	add(name: string, url: string | ToneAudioBuffer | AudioBuffer, callback?: () => void): this {

package/Tone/source/oscillator/OmniOscillator.ts

@@ -315,7 +315,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 
 	/**
 	 * The width of the oscillator when sourceType === "pulse".
-	 * See [[PWMOscillator.width]]
+	 * See [[PWMOscillator]]
 	 */
 	get width(): IsPulseOscillator<OscType, Signal<"audioRange">> {
 		if (this._getOscType(this._oscillator, "pulse")) {

package/Tone/version.ts

@@ -1 +1 @@
-export const version: string = "14.8.48";
+export const version: string = "14.9.0";