mirror of
https://github.com/Tonejs/Tone.js
synced 2025-01-13 20:39:06 +00:00
organizing docs (#1235)
This commit is contained in:
parent
f8fcc4cec6
commit
080856221c
4 changed files with 11 additions and 2 deletions
|
@ -20,6 +20,7 @@ export type ToneAudioNodeOptions = ToneWithContextOptions;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* ToneAudioNode is the base class for classes which process audio.
|
* ToneAudioNode is the base class for classes which process audio.
|
||||||
|
* @category Core
|
||||||
*/
|
*/
|
||||||
export abstract class ToneAudioNode<Options extends ToneAudioNodeOptions = ToneAudioNodeOptions>
|
export abstract class ToneAudioNode<Options extends ToneAudioNodeOptions = ToneAudioNodeOptions>
|
||||||
extends ToneWithContext<Options> {
|
extends ToneWithContext<Options> {
|
||||||
|
|
|
@ -35,4 +35,5 @@ export { Unit };
|
||||||
|
|
||||||
// export the debug stuff as Debug
|
// export the debug stuff as Debug
|
||||||
import * as debug from "./util/Debug";
|
import * as debug from "./util/Debug";
|
||||||
|
/** @internal */
|
||||||
export { debug };
|
export { debug };
|
||||||
|
|
|
@ -52,6 +52,7 @@ export function deepEquals<T>(arrayA: T[], arrayB: T[]): boolean {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Convert an args array into an object.
|
* Convert an args array into an object.
|
||||||
|
* @internal
|
||||||
*/
|
*/
|
||||||
export function optionsFromArguments<T extends object>(
|
export function optionsFromArguments<T extends object>(
|
||||||
defaults: T,
|
defaults: T,
|
||||||
|
@ -101,6 +102,7 @@ export function getDefaultsFromInstance<T>(instance: T): BaseToneOptions {
|
||||||
/**
|
/**
|
||||||
* Returns the fallback if the given object is undefined.
|
* Returns the fallback if the given object is undefined.
|
||||||
* Take an array of arguments and return a formatted options object.
|
* Take an array of arguments and return a formatted options object.
|
||||||
|
* @internal
|
||||||
*/
|
*/
|
||||||
export function defaultArg<T>(given: T, fallback: T): T {
|
export function defaultArg<T>(given: T, fallback: T): T {
|
||||||
if (isUndef(given)) {
|
if (isUndef(given)) {
|
||||||
|
|
|
@ -5,10 +5,15 @@
|
||||||
"defaultCategory" : "Global",
|
"defaultCategory" : "Global",
|
||||||
"categorizeByGroup" : true,
|
"categorizeByGroup" : true,
|
||||||
"categoryOrder" : ["Core", "Source", "Instrument", "Effect", "Component", "Signal"],
|
"categoryOrder" : ["Core", "Source", "Instrument", "Effect", "Component", "Signal"],
|
||||||
|
"navigation" : {
|
||||||
|
"includeCategories": true,
|
||||||
|
"includeFolders": false,
|
||||||
|
"includeGroups": true
|
||||||
|
},
|
||||||
"externalPattern": ["**/node_modules/**"],
|
"externalPattern": ["**/node_modules/**"],
|
||||||
"excludeProtected" : true,
|
"excludeProtected" : true,
|
||||||
"excludePrivate" : true,
|
"excludePrivate" : true,
|
||||||
"hideGenerator": true,
|
"hideGenerator": true,
|
||||||
"includeVersion": true,
|
"includeVersion": false,
|
||||||
"excludeInternal": true
|
"excludeInternal": true,
|
||||||
}
|
}
|
Loading…
Reference in a new issue