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.

Examples

   {break(expression):message}

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

Extends

• BaseParser

Implements

• IParser

Constructors

new BreakParser()

Returns

BreakParser

Overrides

BaseParser.constructor

Defined in

Parsers/Break.ts:26

Properties

acceptedNames

Inherited from

BaseParser.acceptedNames

Defined in

Parsers/Base.ts:8

requiredParameter

Inherited from

BaseParser.requiredParameter

Defined in

Parsers/Base.ts:10

requiredPayload

Inherited from

BaseParser.requiredPayload

Defined in

Parsers/Base.ts:12

Methods

parse()

Parses the given tag.

Parameters

• ctx: Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

Defined in

Parsers/Break.ts:30

toJSON()

Returns

object

acceptedNames

requiredParameter

requiredPayload

Inherited from

BaseParser.toJSON

Defined in

Parsers/Base.ts:29

willAccept()

Whether the parser can handle the given tag.

Parameters

• ctx: Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept

Defined in

Parsers/Base.ts:20