working on getting actions to run

Tonejs · Apr 25, 2024 · 5d910ca · 5d910ca
1 parent 08df7ad
commit 5d910ca
Show file tree

Hide file tree

Showing 17 changed files with 118 additions and 88 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -0,0 +1,28 @@
+name: Run tests
+
+on:
+    pull_request:
+        types: [opened, reopened, synchronize]
+        branches:
+            - dev
+    push:
+        branches:
+            - dev
+jobs:
+    all-tests:
+        permissions:
+            contents: read
+            id-token: write
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out Git repository
+              uses: actions/checkout@v2
+            - name: Setup Nodejs
+              uses: actions/setup-node@v4
+              with:
+                  node-version: 18.12.0
+                  cache: 'npm'
+            - name: Install dependencies
+              run: npm install
+            - name: Build
+              run: npm run build
diff --git a/Tone/component/channel/Channel.ts b/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;

diff --git a/Tone/core/context/Context.ts b/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)) {

diff --git a/Tone/core/context/ToneAudioNode.ts b/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();

diff --git a/Tone/core/context/ToneWithContext.ts b/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);

diff --git a/Tone/instrument/DuoSynth.ts b/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();

diff --git a/Tone/instrument/PolySynth.ts b/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.

diff --git a/Tone/source/buffer/Player.test.ts b/Tone/source/buffer/Player.test.ts
@@ -709,11 +709,14 @@ describe("Player", () => {
 					setTimeout(() => {
 						player.restart(undefined, undefined, 1);
 						const checkStopTimes = new Set();
+						// @ts-ignore
 						player._activeSources.forEach(source => {
+							// @ts-ignore
 							checkStopTimes.add(source._stopTime);
 						});
 						getContext().lookAhead = originalLookAhead;
 						// ensure each source has a different stopTime
+						// @ts-ignore
 						expect(checkStopTimes.size).to.equal(player._activeSources.size);
 						done();
 					}, 250);

diff --git a/Tone/source/buffer/Players.ts b/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 {

diff --git a/Tone/source/oscillator/OmniOscillator.ts b/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")) {

diff --git a/examples/meter.html b/examples/meter.html
@@ -33,7 +33,7 @@
 		}).toDestination();
 
 		const toneMeter = new Tone.Meter({
-			channels: 2,
+			channelCount: 2,
 		});
 		player.connect(toneMeter);
 

diff --git a/examples/mixer.html b/examples/mixer.html
@@ -55,7 +55,7 @@
 		}
 
 		// create a meter on the destination node
-		const toneMeter = new Tone.Meter({ channels: 2 });
+		const toneMeter = new Tone.Meter({ channelCount: 2 });
 		Tone.Destination.chain(toneMeter);
 		meter({
 			tone: toneMeter,

diff --git a/examples/pingPongDelay.html b/examples/pingPongDelay.html
@@ -39,7 +39,7 @@
 		// play a snare sound through it
 		const player = new Tone.Player("https://tonejs.github.io/audio/drum-samples/CR78/snare.mp3").connect(feedbackDelay);
 
-		const toneMeter = new Tone.Meter({ channels: 2 });
+		const toneMeter = new Tone.Meter({ channelCount: 2 });
 		feedbackDelay.connect(toneMeter);
 
 		meter({

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "tone",
-	"version": "14.8.0",
+	"version": "14.9.0",
 	"description": "A Web Audio framework for making interactive music in the browser.",
 	"browser": "build/Tone.js",
 	"main": "build/esm/index.js",
@@ -103,7 +103,7 @@
 		"yargs": "^17.3.0"
 	},
 	"dependencies": {
-		"standardized-audio-context": "^25.3.37",
+		"standardized-audio-context": "^25.3.70",
 		"tslib": "^2.3.1"
 	},
 	"prettier": {

diff --git a/scripts/typedoc.json b/scripts/typedoc.json
@@ -1,12 +1,12 @@
 {
 	"name" : "Tone.js",
-	"mode": "file",
+	"entryPoints": ["../Tone"],
+	"out":"../docs",
 	"defaultCategory" : "Global",
 	"categorizeByGroup" : true,
 	"categoryOrder" : ["Core", "Source", "Instrument", "Effect", "Component", "Signal"],
 	"exclude" : ["./Tone/**/*.test.ts", "./test/**/*.ts"],
 	"excludeProtected" : true,
 	"excludePrivate" : true,
-	"listInvalidSymbolLinks" : true,
-	"excludeNotExported" : false
+	"hideGenerator": true,
 }