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

    Function exportJins

    • Exports comprehensive data for a specific jins.

      This function generates a detailed export of a jins including its basic properties, all possible transpositions within a given tuning system, and optionally its modulation possibilities. The jins can be provided as either a Jins instance or JinsData object.

      Parameters

      • jinsInput: Jins | default

        The jins to export (either Jins instance or JinsData)

      • tuningSystem: default

        The tuning system context for analysis

      • startingNote: string

        The starting note for the tuning system

      • options: JinsExportOptions

        Export configuration options for jins-specific data

      • centsTolerance: number = 5

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

      Returns Promise<ExportedJins>

      Comprehensive export object containing all requested jins data