moment-of-symmetry/dist/src/names.d.ts

Moment of Symmetry (MOS) musical scale generation and analysis for Javascript

/** TAMNAMS information about a MOS pattern. */
export type TamnamsInfo = {
    /** TAMNAMS name of the MOS pattern. */
    name: string;
    /** Interval prefix. */
    prefix?: string;
    /** TAMNAMS name abbreviation. */
    abbreviation?: string;
    /** Family tree prefix. */
    familyPrefix?: string;
    /** Nickname. */
    nickname?: string;
};
/**
 * Retreive TAMNAMS information about a MOS pattern.
 * @param {string} mosPattern MOS pattern such as "5L 2s".
 * @returns {TamnamsInfo} Information about the MOS pattern.
 */
export declare function tamnamsInfo(mosPattern: string): TamnamsInfo | undefined;
/**
 * Retreive TAMNAMS information about a MOS pattern.
 * @param numberOfLargeSteps Number of large steps in the MOS pattern.
 * @param numberOfSmallSteps Number of small steps in the MOS pattern.
 * @returns {TamnamsInfo} Information about the MOS pattern.
 */
export declare function tamnamsInfo(numberOfLargeSteps: number, numberOfSmallSteps: number): TamnamsInfo | undefined;
/**
 * Retrieve the name for a MOS mode.
 * @param mode Mode in step pattern format such as "LLsLLLs".
 * @param extra If true adds extra mode names in parenthesis such as Ionian (Major).
 * @returns Name of the mode.
 */
export declare function modeName(mode: string, extra?: boolean): string | undefined;