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()

new BreakParser(): BreakParser

Returns

BreakParser

Overrides

BaseParser.constructor

Source

lib/Parsers/Break.ts:26

Properties

acceptedNames

protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames

Source

lib/Parsers/Base.ts:8

requiredParameter

protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter

Source

lib/Parsers/Base.ts:10

requiredPayload

protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Source

lib/Parsers/Base.ts:12

Methods

parse()

parse(ctx): string

Parameters

• ctx: Context

Returns

string

Implementation of

IParser.parse

Source

lib/Parsers/Break.ts:30

toJSON()

toJSON(): object

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON

Source

lib/Parsers/Base.ts:29

willAccept()

willAccept(ctx): boolean

Parameters

• ctx: Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept

Source

lib/Parsers/Base.ts:20