Class: BreakParser

Defined in: Parsers/Break.ts:25

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

Defined in: Parsers/Break.ts:26

Returns

BreakParser

Overrides

BaseParser.constructor

Properties

acceptedNames

protected acceptedNames: string[]

Defined in: Parsers/Base.ts:8

Inherited from

BaseParser.acceptedNames

requiredParameter

protected requiredParameter: boolean

Defined in: Parsers/Base.ts:10

Inherited from

BaseParser.requiredParameter

requiredPayload

protected requiredPayload: boolean

Defined in: Parsers/Base.ts:12

Inherited from

BaseParser.requiredPayload

Methods

parse()

parse(ctx): string

Defined in: Parsers/Break.ts:30

Parses the given tag.

Parameters

ctx

Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

toJSON()

toJSON(): object

Defined in: Parsers/Base.ts:29

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON

willAccept()

willAccept(ctx): boolean

Defined in: Parsers/Base.ts:20

Whether the parser can handle the given tag.

Parameters

ctx

Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept

On this page