API Docs for: 1.4.4
Show:

ukeGeeks.chordParser Class

Defined in: scriptasaurus\ukeGeeks.chordParser.js:1
Module: ukeGeeks

Reads an HTML (text) block looking for chords in format: [Emaj7] Returns the HTML block with wrapped chords: <code><strong><em>

Methods

_encloseChords

(
  • text
  • chords
)
String private

Defined in scriptasaurus\ukeGeeks.chordParser.js:97

Returns the input string having replaced all of the "bracketed chord names" (i.e. [D7]) with HTML marked-up version (i.e. <code><strong>[<em>D7</em>]</strong></code>)

Parameters:

  • text String
  • chords StringArray

Returns:

String:

_findChords

(
  • text
)
StringArray private

Defined in scriptasaurus\ukeGeeks.chordParser.js:58

Returns an array of all of the unique bracket chord names. So even if [D7] appears a dozen times you'll only see it once in this list.

Parameters:

  • text String

    CPM Text Block to be parsed

Returns:

StringArray:

_packChords

(
  • text
)
String private

Defined in scriptasaurus\ukeGeeks.chordParser.js:127

Looks for consecutive chords and strips the whitespace between them -- thus "packing" the chords against each other with only a single space separating them.

Parameters:

  • text String

Returns:

String:

getChords

() Array-chords

Defined in scriptasaurus\ukeGeeks.chordParser.js:44

Getter method for _chords

Returns:

Array-chords:

init

() Void

Defined in scriptasaurus\ukeGeeks.chordParser.js:23

Again this is a constructor replacement. Just here for consistency. Does nothing.

Returns:

Void:

parse

(
  • text
)
String

Defined in scriptasaurus\ukeGeeks.chordParser.js:30

This does all of the work -- it's a Wrapper method that calls all of this classes other (private) methods in correct order.

Parameters:

  • text String

    CPM Text Block to be parsed

Returns:

String:

Properties

_public

Object

Defined in scriptasaurus\ukeGeeks.chordParser.js:9

attach public members to this object