docs: Export Transport, Destination, Listener and Draw (#1371)

tambien · web-flow · commit fdaf8c107a6e · 2025-09-01T13:18:43.000-04:00
* docs: Exporting hidden classes

certain classes were hidden from docs, exporting them now to show up in

* chore(packages): Updating typedoc

* refactor: rename ListenerClass to ListenerInstance

* refactor: rename TransportClass to TransportInstance

* refactor: rename DrawClass to DrawInstance

* refactor: rename DestinationClass to DestinationInstance
diff --git a/Tone/core/clock/Transport.test.ts b/Tone/core/clock/Transport.test.ts
diff --git a/Tone/core/clock/Transport.ts b/Tone/core/clock/Transport.ts
@@ -87,7 +87,7 @@ type TransportCallback = (time: Seconds) => void;
  * Tone.getTransport().start();
  * @category Core
  */
-export class TransportClass
+export class TransportInstance
 	extends ToneWithContext<TransportOptions>
 	implements Emitter<TransportEventNames>
 {
@@ -189,7 +189,7 @@ export class TransportClass
 	constructor(options?: Partial<TransportOptions>);
 	constructor() {
 		const options = optionsFromArguments(
-			TransportClass.getDefaults(),
+			TransportInstance.getDefaults(),
 			arguments
 		);
 		super(options);
@@ -808,14 +808,14 @@ export class TransportClass
 	emit!: (event: any, ...args: any[]) => this;
 }
 
-Emitter.mixin(TransportClass);
+Emitter.mixin(TransportInstance);
 
 //-------------------------------------
 // 	INITIALIZATION
 //-------------------------------------
 
 onContextInit((context) => {
-	context.transport = new TransportClass({ context });
+	context.transport = new TransportInstance({ context });
 });
 
 onContextClose((context) => {
diff --git a/Tone/core/clock/TransportEvent.test.ts b/Tone/core/clock/TransportEvent.test.ts
@@ -1,13 +1,13 @@
 import { expect } from "chai";
 
 import { Offline } from "../../../test/helper/Offline.js";
-import { TransportClass } from "./Transport.js";
+import { TransportInstance } from "./Transport.js";
 import { TransportEvent } from "./TransportEvent.js";
 
 describe("TransportEvent", () => {
 	it("can be created and disposed", () => {
 		return Offline((context) => {
-			const transport = new TransportClass({ context });
+			const transport = new TransportInstance({ context });
 			const event = new TransportEvent(transport, {
 				time: 0,
 			});
@@ -17,7 +17,7 @@ describe("TransportEvent", () => {
 
 	it("has a unique id", () => {
 		return Offline((context) => {
-			const transport = new TransportClass({ context });
+			const transport = new TransportInstance({ context });
 			const event = new TransportEvent(transport, {
 				time: 0,
 			});
@@ -29,7 +29,7 @@ describe("TransportEvent", () => {
 	it("can invoke the callback", async () => {
 		let wasInvoked = false;
 		await Offline((context) => {
-			const transport = new TransportClass({ context });
+			const transport = new TransportInstance({ context });
 			const event = new TransportEvent(transport, {
 				callback: (time) => {
 					expect(time).to.equal(100);
diff --git a/Tone/core/clock/TransportEvent.ts b/Tone/core/clock/TransportEvent.ts
@@ -1,6 +1,6 @@
 import { Seconds, Ticks } from "../type/Units.js";
 import { noOp } from "../util/Interface.js";
-import type { TransportClass as Transport } from "./Transport.js";
+import type { TransportInstance as Transport } from "./Transport.js";
 
 export interface TransportEventOptions {
 	callback: (time: number) => void;
@@ -9,7 +9,7 @@ export interface TransportEventOptions {
 }
 
 /**
- * TransportEvent is an internal class used by {@link TransportClass}
+ * TransportEvent is an internal class used by {@link TransportInstance}
  * to schedule events. Do no invoke this class directly, it is
  * handled from within Tone.Transport.
  */
diff --git a/Tone/core/clock/TransportRepeatEvent.test.ts b/Tone/core/clock/TransportRepeatEvent.test.ts
@@ -1,13 +1,13 @@
 import { expect } from "chai";
 
 import { Offline } from "../../../test/helper/Offline.js";
-import { TransportClass } from "./Transport.js";
+import { TransportInstance } from "./Transport.js";
 import { TransportRepeatEvent } from "./TransportRepeatEvent.js";
 
 describe("TransportRepeatEvent", () => {
 	it("can be created and disposed", async () => {
 		await Offline((context) => {
-			const transport = new TransportClass({ context });
+			const transport = new TransportInstance({ context });
 			const event = new TransportRepeatEvent(transport, {
 				duration: 100,
 				interval: 4,
@@ -19,7 +19,7 @@ describe("TransportRepeatEvent", () => {
 
 	it("generates a unique event ID", async () => {
 		await Offline((context) => {
-			const transport = new TransportClass({ context });
+			const transport = new TransportInstance({ context });
 			const event = new TransportRepeatEvent(transport, {
 				time: 0,
 			});
@@ -30,7 +30,7 @@ describe("TransportRepeatEvent", () => {
 
 	it("is removed from the Transport when disposed", async () => {
 		await Offline((context) => {
-			const transport = new TransportClass({ context });
+			const transport = new TransportInstance({ context });
 			const event = new TransportRepeatEvent(transport, {
 				time: 0,
 			});
diff --git a/Tone/core/clock/TransportRepeatEvent.ts b/Tone/core/clock/TransportRepeatEvent.ts
@@ -2,7 +2,7 @@ import { BaseContext } from "../context/BaseContext.js";
 import { TicksClass } from "../type/Ticks.js";
 import { Seconds, Ticks, Time } from "../type/Units.js";
 import { GT, LT } from "../util/Math.js";
-import type { TransportClass as Transport } from "./Transport.js";
+import type { TransportInstance as Transport } from "./Transport.js";
 import { TransportEvent, TransportEventOptions } from "./TransportEvent.js";
 
 interface TransportRepeatEventOptions extends TransportEventOptions {
diff --git a/Tone/core/context/BaseContext.ts b/Tone/core/context/BaseContext.ts
@@ -1,10 +1,10 @@
-import type { TransportClass as Transport } from "../clock/Transport.js";
+import type { TransportInstance as Transport } from "../clock/Transport.js";
 import { Seconds } from "../type/Units.js";
-import type { DrawClass as Draw } from "../util/Draw.js";
+import type { DrawInstance as Draw } from "../util/Draw.js";
 import { Emitter } from "../util/Emitter.js";
 import { AnyAudioContext } from "./AudioContext.js";
-import type { DestinationClass as Destination } from "./Destination.js";
-import type { ListenerClass as Listener } from "./Listener.js";
+import type { DestinationInstance as Destination } from "./Destination.js";
+import type { ListenerInstance as Listener } from "./Listener.js";
 
 // these are either not used in Tone.js or deprecated and not implemented.
 export type ExcludedFromBaseAudioContext =
diff --git a/Tone/core/context/Context.test.ts b/Tone/core/context/Context.test.ts
@@ -2,13 +2,13 @@ import { expect } from "chai";
 
 import { ConstantOutput } from "../../../test/helper/ConstantOutput.js";
 import { Offline } from "../../../test/helper/Offline.js";
-import { TransportClass } from "../clock/Transport.js";
+import { TransportInstance } from "../clock/Transport.js";
 import { getContext } from "../Global.js";
-import { DrawClass } from "../util/Draw.js";
+import { DrawInstance } from "../util/Draw.js";
 import { createAudioContext } from "./AudioContext.js";
 import { Context } from "./Context.js";
-import { DestinationClass } from "./Destination.js";
-import { ListenerClass } from "./Listener.js";
+import { DestinationInstance } from "./Destination.js";
+import { ListenerInstance } from "./Listener.js";
 import { connect } from "./ToneAudioNode.js";
 
 describe("Context", () => {
@@ -19,9 +19,9 @@ describe("Context", () => {
 		const ctxDraw = context.draw;
 		const ctxTransport = context.transport;
 		const ctxListener = context.listener;
-		expect(context.destination).is.instanceOf(DestinationClass);
-		expect(context.draw).is.instanceOf(DrawClass);
-		expect(context.listener).is.instanceOf(ListenerClass);
+		expect(context.destination).is.instanceOf(DestinationInstance);
+		expect(context.draw).is.instanceOf(DrawInstance);
+		expect(context.listener).is.instanceOf(ListenerInstance);
 		await context.close();
 		expect(ctxDest.disposed).to.be.true;
 		expect(ctxDraw.disposed).to.be.true;
@@ -214,7 +214,7 @@ describe("Context", () => {
 
 		it("is invoked in the offline context", () => {
 			return Offline((context) => {
-				const transport = new TransportClass({ context });
+				const transport = new TransportInstance({ context });
 				transport.context.setTimeout(() => {
 					expect(transport.now()).to.be.closeTo(0.01, 0.005);
 				}, 0.01);
diff --git a/Tone/core/context/Context.ts b/Tone/core/context/Context.ts
@@ -1,10 +1,10 @@
 import { Ticker, TickerClockSource } from "../clock/Ticker.js";
-import type { TransportClass as Transport } from "../clock/Transport.js";
+import type { TransportInstance as Transport } from "../clock/Transport.js";
 import { Seconds } from "../type/Units.js";
 import { isAudioContext } from "../util/AdvancedTypeCheck.js";
 import { assert } from "../util/Debug.js";
 import { optionsFromArguments } from "../util/Defaults.js";
-import type { DrawClass as Draw } from "../util/Draw.js";
+import type { DrawInstance as Draw } from "../util/Draw.js";
 import { Timeline } from "../util/Timeline.js";
 import { isDefined } from "../util/TypeCheck.js";
 import {
@@ -14,8 +14,8 @@ import {
 } from "./AudioContext.js";
 import { BaseContext, ContextLatencyHint } from "./BaseContext.js";
 import { closeContext, initializeContext } from "./ContextInitialization.js";
-import type { DestinationClass as Destination } from "./Destination.js";
-import type { ListenerClass as Listener } from "./Listener.js";
+import type { DestinationInstance as Destination } from "./Destination.js";
+import type { ListenerInstance as Listener } from "./Listener.js";
 
 export interface ContextOptions {
 	clockSource: TickerClockSource;
@@ -117,12 +117,16 @@ export class Context extends BaseContext {
 			// custom context provided, latencyHint unknown (unless explicitly provided in options)
 			this._latencyHint = arguments[0]?.latencyHint || "";
 		} else {
-			this._context = createAudioContext(options.sampleRate ? {
-				latencyHint: options.latencyHint,
-				sampleRate: options.sampleRate,
-			} : {
-				latencyHint: options.latencyHint,
-			});
+			this._context = createAudioContext(
+				options.sampleRate
+					? {
+							latencyHint: options.latencyHint,
+							sampleRate: options.sampleRate,
+						}
+					: {
+							latencyHint: options.latencyHint,
+						}
+			);
 			this._latencyHint = options.latencyHint;
 		}
 
diff --git a/Tone/core/context/Destination.test.ts b/Tone/core/context/Destination.test.ts
@@ -5,11 +5,11 @@ import { Offline } from "../../../test/helper/Offline.js";
 import { PassAudio } from "../../../test/helper/PassAudio.js";
 import { Oscillator } from "../../source/oscillator/Oscillator.js";
 import { getContext } from "../Global.js";
-import { DestinationClass } from "./Destination.js";
+import { DestinationInstance } from "./Destination.js";
 
 describe("Destination", () => {
 	it("creates itself on the context", () => {
-		expect(getContext().destination).instanceOf(DestinationClass);
+		expect(getContext().destination).instanceOf(DestinationInstance);
 	});
 
 	it("can be muted and unmuted", () => {
diff --git a/Tone/core/context/Destination.ts b/Tone/core/context/Destination.ts
@@ -30,7 +30,7 @@ interface DestinationOptions extends ToneAudioNodeOptions {
  * oscillator.toDestination();
  * @category Core
  */
-export class DestinationClass extends ToneAudioNode<DestinationOptions> {
+export class DestinationInstance extends ToneAudioNode<DestinationOptions> {
 	readonly name: string = "Destination";
 
 	input: Volume = new Volume({ context: this.context });
@@ -49,7 +49,7 @@ export class DestinationClass extends ToneAudioNode<DestinationOptions> {
 	constructor(options: Partial<DestinationOptions>);
 	constructor() {
 		const options = optionsFromArguments(
-			DestinationClass.getDefaults(),
+			DestinationInstance.getDefaults(),
 			arguments
 		);
 		super(options);
@@ -133,7 +133,7 @@ export class DestinationClass extends ToneAudioNode<DestinationOptions> {
 //-------------------------------------
 
 onContextInit((context) => {
-	context.destination = new DestinationClass({ context });
+	context.destination = new DestinationInstance({ context });
 });
 
 onContextClose((context) => {
diff --git a/Tone/core/context/DummyContext.ts b/Tone/core/context/DummyContext.ts
@@ -1,10 +1,10 @@
-import type { TransportClass as Transport } from "../clock/Transport.js";
+import type { TransportInstance as Transport } from "../clock/Transport.js";
 import { Seconds } from "../type/Units.js";
-import type { DrawClass as Draw } from "../util/Draw.js";
+import type { DrawInstance as Draw } from "../util/Draw.js";
 import { AnyAudioContext } from "./AudioContext.js";
 import { BaseContext } from "./BaseContext.js";
-import type { DestinationClass as Destination } from "./Destination.js";
-import type { ListenerClass as Listener } from "./Listener.js";
+import type { DestinationInstance as Destination } from "./Destination.js";
+import type { ListenerInstance as Listener } from "./Listener.js";
 
 export class DummyContext extends BaseContext {
 	//---------------------------
diff --git a/Tone/core/context/Listener.test.ts b/Tone/core/context/Listener.test.ts
@@ -2,11 +2,11 @@ import { expect } from "chai";
 
 import { Offline } from "../../../test/helper/Offline.js";
 import { getContext } from "../Global.js";
-import { ListenerClass } from "./Listener.js";
+import { ListenerInstance } from "./Listener.js";
 
 describe("Listener", () => {
 	it("creates itself on the context", () => {
-		expect(getContext().listener).instanceOf(ListenerClass);
+		expect(getContext().listener).instanceOf(ListenerInstance);
 	});
 
 	it("can get and set values as an object", () => {
diff --git a/Tone/core/context/Listener.ts b/Tone/core/context/Listener.ts
@@ -19,8 +19,9 @@ export interface ListenerOptions extends ToneAudioNodeOptions {
  * with {@link Panner3D} makes up the Web Audio API's 3D panning system. Panner3D allows you
  * to place sounds in 3D and Listener allows you to navigate the 3D sound environment from
  * a first-person perspective. There is only one listener per audio context.
+ * @category Core
  */
-export class ListenerClass extends ToneAudioNode<ListenerOptions> {
+export class ListenerInstance extends ToneAudioNode<ListenerOptions> {
 	readonly name: string = "Listener";
 
 	/**
@@ -108,7 +109,7 @@ export class ListenerClass extends ToneAudioNode<ListenerOptions> {
 //-------------------------------------
 
 onContextInit((context) => {
-	context.listener = new ListenerClass({ context });
+	context.listener = new ListenerInstance({ context });
 });
 
 onContextClose((context) => {
diff --git a/Tone/core/context/ToneWithContext.ts b/Tone/core/context/ToneWithContext.ts
@@ -110,7 +110,7 @@ export abstract class ToneWithContext<
 
 	/**
 	 * Convert the incoming time to seconds.
-	 * This is calculated against the current {@link TransportClass} bpm
+	 * This is calculated against the current {@link TransportInstance} bpm
 	 * @example
 	 * const gain = new Tone.Gain();
 	 * setInterval(() => console.log(gain.toSeconds("4n")), 100);
diff --git a/Tone/core/index.ts b/Tone/core/index.ts
@@ -1,10 +1,7 @@
 export * from "./clock/Clock.js";
-// export * from "./clock/Transport";
-
 export * from "./context/BaseContext.js";
 export * from "./context/Context.js";
 export * from "./context/Delay.js";
-// export * from "./context/Destination";
 export * from "./context/Gain.js";
 export * from "./context/Offline.js";
 export * from "./context/OfflineContext.js";
diff --git a/Tone/core/util/Draw.test.ts b/Tone/core/util/Draw.test.ts
@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { DrawClass } from "./Draw.js";
+import { DrawInstance } from "./Draw.js";
 
 describe("Draw", () => {
 	const originalRAF = window.requestAnimationFrame;
@@ -15,7 +15,7 @@ describe("Draw", () => {
 	});
 
 	it("can schedule a callback at a AudioContext time", (done) => {
-		const draw = new DrawClass();
+		const draw = new DrawInstance();
 		const scheduledTime = draw.now() + 0.2;
 		draw.schedule(() => {
 			expect(draw.context.currentTime).to.be.closeTo(scheduledTime, 0.05);
@@ -25,7 +25,7 @@ describe("Draw", () => {
 	});
 
 	it("can schedule multiple callbacks", (done) => {
-		const draw = new DrawClass();
+		const draw = new DrawInstance();
 		let callbackCount = 0;
 		const firstEvent = draw.now() + 0.1;
 		draw.schedule(() => {
@@ -50,7 +50,7 @@ describe("Draw", () => {
 	});
 
 	it("can cancel scheduled events", (done) => {
-		const draw = new DrawClass();
+		const draw = new DrawInstance();
 		let callbackCount = 0;
 		draw.schedule(() => {
 			callbackCount++;
diff --git a/Tone/core/util/Draw.ts b/Tone/core/util/Draw.ts
@@ -31,7 +31,7 @@ interface DrawEvent extends TimelineEvent {
  * Tone.Transport.start();
  * @category Core
  */
-export class DrawClass extends ToneWithContext<ToneWithContextOptions> {
+export class DrawInstance extends ToneWithContext<ToneWithContextOptions> {
 	readonly name: string = "Draw";
 
 	/**
@@ -122,7 +122,7 @@ export class DrawClass extends ToneWithContext<ToneWithContextOptions> {
 //-------------------------------------
 
 onContextInit((context) => {
-	context.draw = new DrawClass({ context });
+	context.draw = new DrawInstance({ context });
 });
 
 onContextClose((context) => {
diff --git a/Tone/fromContext.ts b/Tone/fromContext.ts
diff --git a/Tone/index.test.ts b/Tone/index.test.ts
diff --git a/Tone/index.ts b/Tone/index.ts
diff --git a/Tone/signal/SyncedSignal.ts b/Tone/signal/SyncedSignal.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
