tonejs

name	tonejs
description	Build browser audio and interactive music with Tone.js in TypeScript/JavaScript. Use when creating synths, samplers, players, effects, sequences, transport-synced events, Web Audio graphs, or any UI that makes sound with Tone.js.

Tone.js

Tone.js is a Web Audio framework for interactive music in the browser.

When working with Tone.js, read the relevant local reference first. The files in references/ mirror the Tone.js README, examples, and TypeDoc API docs.

Critical rules

• Browser audio must start from a user gesture. Call await Tone.start() in a click/key handler before playing sound.
• Dispose nodes you create (synth.dispose(), effect.dispose(), etc.) when UI components unmount or sounds are no longer needed.
• Schedule with Tone's audio clock (Tone.now(), Tone.getTransport() / Tone.Transport, triggerAttackRelease(..., time)) instead of setTimeout for musical timing.
• In new code, prefer Tone.getTransport() over the deprecated global Tone.Transport; many official examples still use Tone.Transport.
• In TypeScript modules, prefer import * as Tone from "tone"; examples from the Tone.js repo often use a global Tone object in browser HTML.

Minimal example

import * as Tone from "tone";

async function play() {
  await Tone.start();
  const synth = new Tone.Synth().toDestination();
  synth.triggerAttackRelease("C4", "8n");
}

Start here

• README / installation / hello world
• Full API map (298 TypeDoc pages)
• Examples map (34 examples)
• Class hierarchy

Common API references

• Install/import and hello world
• Start audio after a user gesture
• Current AudioContext time
• Transport getter
• Wait for samples/buffers to load
• Synth
• PolySynth
• Sampler
• Player
• Transport
• Sequence
• Part
• Loop
• Reverb
• PingPongDelay
• Filter
• Envelope

Common examples

• Simple Synth
• PolySynth
• Sampler
• Player
• Step Sequencer
• Events
• PingPongDelay
• Reverb
• Offline Rendering

Task guide

• Simple note or synth sound: read Synth and start.
• Chords/polyphony: read PolySynth.
• Sample playback: read Sampler, Player, and loaded.
• Rhythms/sequencing: read getTransport, Transport, Sequence, Part, and Loop.
• Effects chain: read the effect class, then connect with .connect(), .chain(), or .toDestination().