organizing docs (#1235)

This commit is contained in:
Yotam Mann 2024-04-29 10:48:28 -04:00 committed by GitHub
parent f8fcc4cec6
commit 080856221c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 11 additions and 2 deletions

View file

@ -20,6 +20,7 @@ export type ToneAudioNodeOptions = ToneWithContextOptions;
/**
* ToneAudioNode is the base class for classes which process audio.
* @category Core
*/
export abstract class ToneAudioNode<Options extends ToneAudioNodeOptions = ToneAudioNodeOptions>
extends ToneWithContext<Options> {

View file

@ -35,4 +35,5 @@ export { Unit };
// export the debug stuff as Debug
import * as debug from "./util/Debug";
/** @internal */
export { debug };

View file

@ -52,6 +52,7 @@ export function deepEquals<T>(arrayA: T[], arrayB: T[]): boolean {
/**
* Convert an args array into an object.
* @internal
*/
export function optionsFromArguments<T extends object>(
defaults: T,
@ -101,6 +102,7 @@ export function getDefaultsFromInstance<T>(instance: T): BaseToneOptions {
/**
* Returns the fallback if the given object is undefined.
* Take an array of arguments and return a formatted options object.
* @internal
*/
export function defaultArg<T>(given: T, fallback: T): T {
if (isUndef(given)) {

View file

@ -5,10 +5,15 @@
"defaultCategory" : "Global",
"categorizeByGroup" : true,
"categoryOrder" : ["Core", "Source", "Instrument", "Effect", "Component", "Signal"],
"navigation" : {
"includeCategories": true,
"includeFolders": false,
"includeGroups": true
},
"externalPattern": ["**/node_modules/**"],
"excludeProtected" : true,
"excludePrivate" : true,
"hideGenerator": true,
"includeVersion": true,
"excludeInternal": true
"includeVersion": false,
"excludeInternal": true,
}