chordsheetjs
    Preparing search index...

    Class ChordSheetSerializer

    Serializes a song into een plain object, and deserializes the serialized object back into a Song

    Index

    Methods

    • Deserializes a song that has been serialized using serialize

      Parameters

      • serializedSong: SerializedSong

        The serialized song

      • Optionaloptions: { notation?: "german" | null } = {}

        Deserialization options

        • Optionalnotation?: "german" | null

          When 'german', chord strings on the song are eagerly parsed with German notation (B = B-flat, H = B natural) so the preference survives transpose and re-serialization. Defaults to English semantics.

      Returns Song

      The deserialized song

    • Serializes the chord sheet to a plain object, which can be converted to any format like JSON, XML etc Can be deserialized using deserialize

      Parameters

      Returns SerializedSong

      object A plain JS object containing all chord sheet data