@witchcraft/spellcraft
    Preparing search index...

    Function equalsKeys

    • Returns if the given chords are equal.

      Can be passed a length, to limit the search to only the first x chords.

      equalsKeys([[keyA]], [[keyA]]) // true
      equalsKeys([[keyA], [keyB]], [[keyA]]) // false
      equalsKeys([[keyA], [keyB]], [[keyA]], 1) // true
      equalsKeys([[keyA], [keyB]], [[keyA], [keyB]], 2) // true
      equalsKeys([[keyA], [keyB]], [[keyA], [keyB], [keyC]], 3) // false
      equalsKeys([[keyA], [keyB]], [[keyB]], 1) // false

      Can also pass options to equalsKey:

      equalsKeys([[keyA], [keyB]], [[keyAVariant], [keyB]], 2, { allowVariants: true }) // true
      

      Parameters

      • chain: readonly string[][]
      • base: readonly string[][]
      • keys: Keys
      • Optionallength: number
      • opts: { allowVariants?: boolean } = {}

      Returns boolean