Tone.js/Tone/fromContext.ts
Yotam Mann 3d42017f50
Deprecating singleton variables, use singleton getter instead (#1233)
* Deprecating singleton variables, use singleton getter instead

* updating references

* moving over to getters instead of global vars
2024-04-28 13:05:26 -04:00

77 lines
2.6 KiB
TypeScript

import * as Classes from "./classes";
import { TransportClass } from "./core/clock/Transport";
import { Context } from "./core/context/Context";
import { ListenerClass } from "./core/context/Listener";
import { DestinationClass } from "./core/context/Destination";
import { FrequencyClass } from "./core/type/Frequency";
import { MidiClass } from "./core/type/Midi";
import { TicksClass } from "./core/type/Ticks";
import { TimeClass } from "./core/type/Time";
import { TransportTimeClass } from "./core/type/TransportTime";
import { isDefined, isFunction } from "./core/util/TypeCheck";
import { omitFromObject } from "./core/util/Defaults";
import { DrawClass } from "./core/util/Draw";
type ClassesWithoutSingletons = Omit<typeof Classes, "Transport" | "Destination" | "Draw">;
/**
* The exported Tone object. Contains all of the classes that default
* to the same context and contains a singleton Transport and Destination node.
*/
type ToneObject = {
Transport: TransportClass;
Destination: DestinationClass;
Listener: ListenerClass;
Draw: DrawClass;
context: Context;
now: () => number;
immediate: () => number;
} & ClassesWithoutSingletons;
/**
* Bind the TimeBaseClass to the context
*/
function bindTypeClass(context: Context, type) {
return (...args: unknown[]) => new type(context, ...args);
}
/**
* Return an object with all of the classes bound to the passed in context
* @param context The context to bind all of the nodes to
*/
export function fromContext(context: Context): ToneObject {
const classesWithContext: Partial<ClassesWithoutSingletons> = {};
Object.keys(omitFromObject(Classes, ["Transport", "Destination", "Draw"])).map(key => {
const cls = Classes[key];
if (isDefined(cls) && isFunction(cls.getDefaults)) {
classesWithContext[key] = class ToneFromContextNode extends cls {
get defaultContext(): Context {
return context;
}
};
} else {
// otherwise just copy it over
classesWithContext[key] = Classes[key];
}
});
const toneFromContext: ToneObject = {
...(classesWithContext as ClassesWithoutSingletons),
now: context.now.bind(context),
immediate: context.immediate.bind(context),
Transport: context.transport,
Destination: context.destination,
Listener: context.listener,
Draw: context.draw,
context,
// the type functions
Midi: bindTypeClass(context, MidiClass),
Time: bindTypeClass(context, TimeClass),
Frequency: bindTypeClass(context, FrequencyClass),
Ticks: bindTypeClass(context, TicksClass),
TransportTime: bindTypeClass(context, TransportTimeClass),
};
// return the object
return toneFromContext;
}