Class: BreakParser

The break parser will force the tag output to only be the payload of this tag, if the passed expression evaluates true. If no message is provided to the payload, the tag output will be empty. This differs from the StopParser as the stop tag stops all TagScript parsing and returns its message while the break tag continues to parse tags. If any other tags exist after the break tag, they will still execute.

Example

   {break(expression):message}

Example

   {break({args}==):You did not provide any input.}

Hierarchy

• BaseParser

  ↳ BreakParser

Implements

• IParser

Constructors

constructor

• new BreakParser()

Overrides

BaseParser.constructor

Properties

acceptedNames

• Protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames

requiredParameter

• Protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter

requiredPayload

• Protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Methods

parse

▸ parse(ctx): string

Parses the given tag.

Parameters

Returns

string

Implementation of

IParser.parse

willAccept

▸ willAccept(ctx): boolean

Whether the parser can handle the given tag.

Parameters

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept