tone 14.9.11 → 14.9.13

package/Tone/event/Pattern.ts

@@ -121,7 +121,7 @@ export class Pattern<ValueType> extends Loop<PatternOptions<ValueType>> {
 	}
 
 	/**
-	 * The pattern type. See Tone.CtrlPattern for the full list of patterns.
+	 * The pattern type. 
 	 */
 	get pattern(): PatternName {
 		return this._type;

package/Tone/index.ts

@@ -1,4 +1,5 @@
 export { getContext, setContext } from "./core/Global";
+import { BaseContext } from "./core/context/BaseContext";
 export * from "./classes";
 export * from "./version";
 import { getContext } from "./core/Global";
@@ -8,8 +9,8 @@ import { Seconds } from "./core/type/Units";
 export { supported } from "./core/context/AudioContext";
 
 /**
- * The current audio context time of the global [[Context]]. 
- * See [[Context.now]]
+ * The current audio context time of the global {@link BaseContext}. 
+ * @see {@link BaseContext.now}
  * @category Core
  */
 export function now(): Seconds {
@@ -17,8 +18,8 @@ export function now(): Seconds {
 }
 
 /**
- * The current audio context time of the global [[Context]] without the [[Context.lookAhead]]
- * See [[Context.immediate]]
+ * The current audio context time of the global {@link BaseContext} without the {@link BaseContext.lookAhead}
+ * @see {@link BaseContext.immediate}
  * @category Core
  */
 export function immediate(): Seconds {
@@ -27,7 +28,7 @@ export function immediate(): Seconds {
 
 /**
  * The Transport object belonging to the global Tone.js Context.
- * See [[TransportClass]]
+ * @see {@link TransportClass}
  * @category Core
  * @deprecated Use {@link getTransport} instead
  */
@@ -35,7 +36,7 @@ export const Transport = getContext().transport;
 
 /**
  * The Transport object belonging to the global Tone.js Context.
- * See [[TransportClass]]
+ * @see {@link TransportClass}
  * @category Core
  */
 export function getTransport(): import("./core/clock/Transport").TransportClass {
@@ -44,7 +45,7 @@ export function getTransport(): import("./core/clock/Transport").TransportClass
 
 /**
  * The Destination (output) belonging to the global Tone.js Context.
- * See [[DestinationClass]]
+ * @see {@link DestinationClass}
  * @category Core
  * @deprecated Use {@link getDestination} instead
  */
@@ -57,7 +58,7 @@ export const Master = getContext().destination;
 
 /**
  * The Destination (output) belonging to the global Tone.js Context.
- * See [[DestinationClass]]
+ * @see {@link DestinationClass}
  * @category Core
  */
 export function getDestination(): import("./core/context/Destination").DestinationClass {
@@ -65,14 +66,14 @@ export function getDestination(): import("./core/context/Destination").Destinati
 }
 
 /**
- * The [[ListenerClass]] belonging to the global Tone.js Context.
+ * The {@link ListenerClass} belonging to the global Tone.js Context.
  * @category Core
  * @deprecated Use {@link getListener} instead
  */
 export const Listener = getContext().listener;
 
 /**
- * The [[ListenerClass]] belonging to the global Tone.js Context.
+ * The {@link ListenerClass} belonging to the global Tone.js Context.
  * @category Core
  */
 export function getListener(): import("./core/context/Listener").ListenerClass {
@@ -81,7 +82,7 @@ export function getListener(): import("./core/context/Listener").ListenerClass {
 
 /**
  * Draw is used to synchronize the draw frame with the Transport's callbacks. 
- * See [[DrawClass]]
+ * @see {@link DrawClass}
  * @category Core
  * @deprecated Use {@link getDraw} instead
  */
@@ -90,7 +91,7 @@ export const Draw = getContext().draw;
 /**
  * Get the singleton attached to the global context. 
  * Draw is used to synchronize the draw frame with the Transport's callbacks. 
- * See [[DrawClass]]
+ * @see {@link DrawClass}
  * @category Core
  */
 export function getDraw(): import("./core/util/Draw").DrawClass {
@@ -99,14 +100,14 @@ export function getDraw(): import("./core/util/Draw").DrawClass {
 
 /**
  * A reference to the global context
- * See [[Context]]
+ * @see {@link BaseContext}
  * @deprecated Use {@link getContext} instead
  */
 export const context = getContext();
 
 /**
  * Promise which resolves when all of the loading promises are resolved. 
- * Alias for static [[ToneAudioBuffer.loaded]] method.
+ * Alias for static {@link ToneAudioBuffer.loaded} method.
  * @category Core
  */
 export function loaded() {

package/Tone/instrument/DuoSynth.ts

@@ -18,7 +18,7 @@ export interface DuoSynthOptions extends MonophonicOptions {
 }
 
 /**
- * DuoSynth is a monophonic synth composed of two [[MonoSynth]]s run in parallel with control over the
+ * DuoSynth is a monophonic synth composed of two {@link 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/Instrument.ts

@@ -67,7 +67,7 @@ export abstract class Instrument<Options extends InstrumentOptions> extends Tone
 
 	/**
 	 * Sync the instrument to the Transport. All subsequent calls of
-	 * [[triggerAttack]] and [[triggerRelease]] will be scheduled along the transport.
+	 * {@link triggerAttack} and {@link triggerRelease} will be scheduled along the transport.
 	 * @example
 	 * const fmSynth = new Tone.FMSynth().toDestination();
 	 * fmSynth.volume.value = -6;

package/Tone/instrument/MetalSynth.ts

@@ -91,7 +91,7 @@ export class MetalSynth extends Monophonic<MetalSynthOptions> {
 	/**
 	 * The envelope which is connected both to the
 	 * amplitude and a highpass filter's cutoff frequency.
-	 * The lower-limit of the filter is controlled by the [[resonance]]
+	 * The lower-limit of the filter is controlled by the {@link resonance}
 	 */
 	readonly envelope: Envelope;
 
@@ -231,7 +231,7 @@ export class MetalSynth extends Monophonic<MetalSynthOptions> {
 
 	/**
 	 * The modulationIndex of the oscillators which make up the source.
-	 * see [[FMOscillator.modulationIndex]]
+	 * see {@link FMOscillator.modulationIndex}
 	 * @min 1
 	 * @max 100
 	 */

package/Tone/instrument/NoiseSynth.ts

@@ -17,7 +17,7 @@ export interface NoiseSynthOptions extends InstrumentOptions {
 }
 
 /**
- * Tone.NoiseSynth is composed of [[Noise]] through an [[AmplitudeEnvelope]].
+ * Tone.NoiseSynth is composed of {@link Noise} through an {@link AmplitudeEnvelope}.
  * ```
  * +-------+   +-------------------+
  * | Noise +>--> AmplitudeEnvelope +>--> Output

package/Tone/instrument/PluckSynth.ts

@@ -111,7 +111,7 @@ export class PluckSynth extends Instrument<PluckSynthOptions> {
 	}
 
 	/**
-	 * Ramp down the [[resonance]] to 0 over the duration of the release time.
+	 * Ramp down the {@link resonance} to 0 over the duration of the release time.
 	 */
 	triggerRelease(time?: Time): this {
 		this._lfcf.resonance.linearRampTo(0, this.release, time);

package/Tone/instrument/Sampler.ts

@@ -33,7 +33,7 @@ export interface SamplerOptions extends InstrumentOptions {
  * were not explicitly included which can save loading time.
  *
  * For sample or buffer playback where repitching is not necessary,
- * use [[Player]].
+ * use {@link Player}.
  * @example
  * const sampler = new Tone.Sampler({
  * 	urls: {

package/Tone/instrument/Synth.ts

@@ -17,7 +17,7 @@ export interface SynthOptions extends MonophonicOptions {
 }
 
 /**
- * Synth is composed simply of a [[OmniOscillator]] routed through an [[AmplitudeEnvelope]].
+ * Synth is composed simply of a {@link OmniOscillator} routed through an {@link AmplitudeEnvelope}.
  * ```
  * +----------------+   +-------------------+
  * | OmniOscillator +>--> AmplitudeEnvelope +>--> Output

package/Tone/signal/Add.ts

@@ -39,7 +39,7 @@ export class Add extends Signal {
 	readonly addend: Param<"number"> = this._param;
 
 	/**
-	 * @param value If no value is provided, will sum the input and [[addend]].
+	 * @param value If no value is provided, will sum the input and {@link addend}.
 	 */
 	constructor(value?: number);
 	constructor(options?: Partial<SignalOptions<"number">>);

package/Tone/signal/AudioToGain.ts

@@ -4,7 +4,7 @@ import { WaveShaper } from "./WaveShaper";
 
 /**
  * AudioToGain converts an input in AudioRange [-1,1] to NormalRange [0,1].
- * See [[GainToAudio]].
+ * @see {@link GainToAudio}.
  * @category Signal
  */
 export class AudioToGain extends SignalOperator<ToneAudioNodeOptions> {

package/Tone/signal/GainToAudio.ts

@@ -4,7 +4,7 @@ import { WaveShaper } from "./WaveShaper";
 
 /**
  * GainToAudio converts an input in NormalRange [0,1] to AudioRange [-1,1].
- * See [[AudioToGain]].
+ * @see {@link AudioToGain}.
  * @category Signal
  */
 export class GainToAudio extends SignalOperator<ToneAudioNodeOptions> {

package/Tone/signal/Multiply.ts

@@ -43,7 +43,7 @@ export class Multiply<TypeName extends "number" | "positive" = "number"> extends
 	input: InputNode;
 
 	/**
-	 * The product of the input and [[factor]]
+	 * The product of the input and {@link factor}
 	 */
 	output: OutputNode;
 

package/Tone/signal/ScaleExp.ts

@@ -50,8 +50,8 @@ export class ScaleExp extends Scale<ScaleExpOptions> {
 	}
 
 	/**
-	 * Instead of interpolating linearly between the [[min]] and
-	 * [[max]] values, setting the exponent will interpolate between
+	 * Instead of interpolating linearly between the {@link min} and
+	 * {@link max} values, setting the exponent will interpolate between
 	 * the two values with an exponential curve.
 	 */
 	get exponent(): Positive {

package/Tone/signal/Signal.ts

@@ -192,7 +192,7 @@ export class Signal<TypeName extends UnitName = "number"> extends ToneAudioNode<
 	}
 
 	/**
-	 * See [[Param.apply]].
+	 * @see {@link Param.apply}.
 	 */
 	apply(param: Param | AudioParam): this {
 		this._param.apply(param);

package/Tone/signal/SyncedSignal.ts

@@ -6,7 +6,7 @@ import { ToneConstantSource } from "./ToneConstantSource";
 import { OutputNode } from "../core/context/ToneAudioNode";
 
 /**
- * Adds the ability to synchronize the signal to the [[TransportClass]]
+ * Adds the ability to synchronize the signal to the {@link TransportClass}
  * @category Signal
  */
 export class SyncedSignal<TypeName extends UnitName = "number"> extends Signal<TypeName> {

package/Tone/source/Source.ts

@@ -362,7 +362,8 @@ export abstract class Source<
 	}
 
 	/**
-	 * Unsync the source to the Transport. See Source.sync
+	 * Unsync the source to the Transport. 
+	 * @see {@link sync}
 	 */
 	unsync(): this {
 		if (this._synced) {

package/Tone/source/buffer/Player.ts

@@ -432,7 +432,7 @@ export class Player extends Source<PlayerOptions> {
 	}
 
 	/**
-	 * If the buffer should be reversed. Note that this sets the underlying [[ToneAudioBuffer.reverse]], so
+	 * If the buffer should be reversed. Note that this sets the underlying {@link ToneAudioBuffer.reverse}, so
 	 * if multiple players are pointing at the same ToneAudioBuffer, they will all be reversed.
 	 * @example
 	 * const player = new Tone.Player("https://tonejs.github.io/audio/berklee/chime_1.mp3").toDestination();

package/Tone/source/buffer/Players.ts

@@ -23,7 +23,7 @@ export interface PlayersOptions extends SourceOptions {
 }
 
 /**
- * Players combines multiple [[Player]] objects.
+ * Players combines multiple {@link Player} objects.
  * @category Source
  */
 export class Players extends ToneAudioNode<PlayersOptions> {

package/Tone/source/oscillator/LFO.ts

@@ -94,7 +94,7 @@ export class LFO extends ToneAudioNode<LFOOptions> {
 	private _units: UnitName = "number";
 
 	/**
-	 * If the input value is converted using the [[units]]
+	 * If the input value is converted using the {@link units}
 	 */
 	convert = true;
 
@@ -238,7 +238,8 @@ export class LFO extends ToneAudioNode<LFOOptions> {
 	}
 
 	/**
-	 * The type of the oscillator: See [[Oscillator.type]]
+	 * The type of the oscillator.
+	 * @see {@link Oscillator.type}
 	 */
 	get type(): ToneOscillatorType {
 		return this._oscillator.type;
@@ -249,7 +250,8 @@ export class LFO extends ToneAudioNode<LFOOptions> {
 	}
 
 	/**
-	 * The oscillator's partials array: See [[Oscillator.partials]]
+	 * The oscillator's partials array. 
+	 * @see {@link Oscillator.partials}
 	 */
 	get partials(): number[] {
 		return this._oscillator.partials;

package/Tone/source/oscillator/OmniOscillator.ts

@@ -192,7 +192,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 	/**
 	 * The value is an empty array when the type is not "custom".
 	 * This is not available on "pwm" and "pulse" oscillator types.
-	 * See [[Oscillator.partials]]
+	 * @see {@link Oscillator.partials}
 	 */
 	get partials(): number[] {
 		return this._oscillator.partials;
@@ -297,7 +297,8 @@ export class OmniOscillator<OscType extends AnyOscillator>
 	}
 
 	/**
-	 * The base type of the oscillator. See [[Oscillator.baseType]]
+	 * The base type of the oscillator. 
+	 * @see {@link Oscillator.baseType}
 	 * @example
 	 * const omniOsc = new Tone.OmniOscillator(440, "fmsquare4");
 	 * console.log(omniOsc.sourceType, omniOsc.baseType, omniOsc.partialCount);
@@ -315,7 +316,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 
 	/**
 	 * The width of the oscillator when sourceType === "pulse".
-	 * See [[PWMOscillator]]
+	 * @see {@link PWMOscillator}
 	 */
 	get width(): IsPulseOscillator<OscType, Signal<"audioRange">> {
 		if (this._getOscType(this._oscillator, "pulse")) {
@@ -327,7 +328,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 
 	/**
 	 * The number of detuned oscillators when sourceType === "fat".
-	 * See [[FatOscillator.count]]
+	 * @see {@link FatOscillator.count}
 	 */
 	get count(): IsFatOscillator<OscType, number> {
 		if (this._getOscType(this._oscillator, "fat")) {
@@ -344,7 +345,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 
 	/**
 	 * The detune spread between the oscillators when sourceType === "fat".
-	 * See [[FatOscillator.count]]
+	 * @see {@link FatOscillator.count}
 	 */
 	get spread(): IsFatOscillator<OscType, Cents> {
 		if (this._getOscType(this._oscillator, "fat")) {
@@ -361,7 +362,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 
 	/**
 	 * The type of the modulator oscillator. Only if the oscillator is set to "am" or "fm" types. 
-	 * See [[AMOscillator]] or [[FMOscillator]]
+	 * @see {@link AMOscillator} or {@link FMOscillator}
 	 */
 	get modulationType(): IsAmOrFmOscillator<OscType, ToneOscillatorType> {
 		if (this._getOscType(this._oscillator, "fm") || this._getOscType(this._oscillator, "am")) {
@@ -378,7 +379,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 
 	/**
 	 * The modulation index when the sourceType === "fm"
-	 * See [[FMOscillator]].
+	 * @see {@link FMOscillator}.
 	 */
 	get modulationIndex(): IsFMOscillator<OscType, Signal<"positive">> {
 		if (this._getOscType(this._oscillator, "fm")) {
@@ -390,7 +391,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 
 	/**
 	 * Harmonicity is the frequency ratio between the carrier and the modulator oscillators.
-	 * See [[AMOscillator]] or [[FMOscillator]]
+	 * @see {@link AMOscillator} or {@link FMOscillator}
 	 */
 	get harmonicity(): IsAmOrFmOscillator<OscType, Signal<"positive">> {
 		if (this._getOscType(this._oscillator, "fm") || this._getOscType(this._oscillator, "am")) {
@@ -402,7 +403,7 @@ export class OmniOscillator<OscType extends AnyOscillator>
 
 	/**
 	 * The modulationFrequency Signal of the oscillator when sourceType === "pwm"
-	 * see [[PWMOscillator]]
+	 * see {@link PWMOscillator}
 	 * @min 0.1
 	 * @max 5
 	 */

package/Tone/source/oscillator/Oscillator.ts

@@ -180,7 +180,7 @@ export class Oscillator extends Source<ToneOscillatorOptions> implements ToneOsc
 
 	/**
 	 * Unsync the oscillator's frequency from the Transport.
-	 * See Oscillator.syncFrequency
+	 * @see {@link syncFrequency}
 	 */
 	unsyncFrequency(): this {
 		this.context.transport.unsyncSignal(this.frequency);

package/Tone/source/oscillator/ToneOscillatorNode.ts

@@ -14,7 +14,7 @@ export interface ToneOscillatorNodeOptions extends OneShotSourceOptions {
 /**
  * Wrapper around the native fire-and-forget OscillatorNode.
  * Adds the ability to reschedule the stop method.
- * ***[[Oscillator]] is better for most use-cases***
+ * ***{@link Oscillator} is better for most use-cases***
  * @category Source
  */
 export class ToneOscillatorNode extends OneShotSource<ToneOscillatorNodeOptions> {

package/Tone/version.ts

@@ -1 +1 @@
-export const version: string = "14.9.11";
+export const version: string = "14.9.13";