moment-of-symmetry/dist/src/modes/index.d.ts

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

import { MosPattern, ModeInfo } from '../types';
/**
 * Get information about a mode
 * @param pattern The MOS pattern
 * @param options Optional configuration
 * @returns Information about the mode
 */
export declare function getModeInfo(pattern: MosPattern, options?: {
    extraNames?: boolean;
}): ModeInfo;
/**
 * Get all modes for a given pattern
 * @param pattern The MOS pattern
 * @param options Optional configuration
 * @returns Array of mode information
 */
export declare function getAllModes(pattern: MosPattern, options?: {
    extraNames?: boolean;
}): ModeInfo[];
/**
 * Get the parent MOS pattern for a given pattern
 * @param pattern The MOS pattern to get the parent for
 * @returns The parent MOS pattern
 */
export declare function getParentPattern(pattern: MosPattern): MosPattern;
/**
 * Get the daughter MOS pattern(s) for a given pattern
 * @param pattern The MOS pattern to get the daughter(s) for
 * @returns Array of daughter MOS patterns
 */
export declare function getDaughterPatterns(pattern: MosPattern): MosPattern[];