Arabic Maqām Network - TypeScript Library Documentation - v0.1.0
    Preparing search index...

    Function exportMaqam

    • Exports comprehensive data for a specific maqam.

      This function generates a detailed export of a maqam including its basic properties, constituent ajnas, all possible transpositions within a given tuning system, and optionally its modulation possibilities and suyur (melodic progressions). The maqam can be provided as either a Maqam instance or MaqamData object.

      Note: This function uses the original modulation format (full objects) for better compatibility with individual maqam analysis. For large-scale exports, use exportTuningSystem() which implements index-based optimization.

      Parameters

      • maqamInput: Maqam | default

        The maqam to export (either Maqam instance or MaqamData)

      • tuningSystem: default

        The tuning system context for analysis

      • startingNote: string

        The starting note for the tuning system

      • options: MaqamExportOptions

        Export configuration options for maqam-specific data

      • centsTolerance: number = 5

        Tolerance in cents for matching cents values (default: 5)

      Returns Promise<ExportedMaqam>

      Comprehensive export object containing all requested maqam data