Class ContributionSurveyRowParser

constructor

• new ContributionSurveyRowParser(wikitext): ContributionSurveyRowParser

• Parameters

  • wikitext: string

  Returns ContributionSurveyRowParser

Readonlywikitext

eat

• eat(): string

• Pops the first character off the working string and returns it.

  Returns string

  First character of the working string, pre-mutation.

eatExpression

• eatExpression(pattern, n?): string

• Eats a given expression from the start of the working string. If the working string does not contain the given expression, null is returned (and not a blank string). Only eats once, so any expression must be greedy if different behavior is expected.

  The regular expression passed into this function is automatically re-wrapped with ^(?:<source>). Avoid adding these expressions on your own.

  Parameters

  • pattern: RegExp

    The pattern to match.
  • n: number = 0

    The capture group to return (returns the entire string (0) by default)

  Returns string

  The consumed characters.

eatExpressionMatch

• eatExpressionMatch(pattern): RegExpExecArray

• Eats a given expression from the start of the working string. If the working string does not contain the given expression, null is returned (and not a blank string). Only eats once, so any expression must be greedy if different behavior is expected.

  The regular expression passed into this function is automatically re-wrapped with ^(?:<source>). Avoid adding these expressions on your own.

  Parameters

  • pattern: RegExp

    The pattern to match.

  Returns RegExpExecArray

  A RegExpExecArray.

eatRemaining

• eatRemaining(): string

• Consumes the rest of the working string.

  Returns string

  The remaining characters in the working string.

eatUntil

• eatUntil(pattern, noFinish?): string

• Continue eating from the string until a string or regular expression is matched. Unlike eatExpression, passed regular expressions will not be re-wrapped with ^(?:). These must be added on your own if you wish to match the start of the string.

  Parameters

  • pattern: string | RegExp

    The string or regular expression to match.
  • OptionalnoFinish: boolean

    If set to true, null will be returned instead if the pattern is never matched. The working string will be reset to its original state if this occurs. This prevents the function from being too greedy.

  Returns string

  The consumed characters.

getCurrentLength

• getCurrentLength(): number

• Returns number

  the length of the working string.

isEmpty

• isEmpty(): boolean

• Returns true if the working string is empty.

  Returns boolean

  true if the length of current is zero. false if otherwise.

parse

• parse(): RawContributionSurveyRow

• Parses a wikitext contribution survey row into a RawContributionSurveyRow. If invalid, an Error is thrown with relevant information.

  Returns RawContributionSurveyRow

  Components of a parsed contribution survey row.

peek

• peek(): string

• Views the next character to ContributionSurveyRowParser#eat.

  Returns string

  The first character of the working string.