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
Extends
Implements
Constructors
new BreakParser()
new BreakParser(): BreakParser
Returns
Overrides
Defined in
Properties
acceptedNames
protected acceptedNames: string[]
Inherited from
Defined in
requiredParameter
protected requiredParameter: boolean
Inherited from
Defined in
requiredPayload
protected requiredPayload: boolean
Inherited from
Defined in
Methods
parse()
parse(ctx): string
Parses the given tag.
Parameters
ctx
The context of the tag.
Returns
string
Implementation of
Defined in
toJSON()
toJSON(): object
Returns
object
acceptedNames
acceptedNames: string[]
requiredParameter
requiredParameter: boolean
requiredPayload
requiredPayload: boolean
Inherited from
Defined in
willAccept()
willAccept(ctx): boolean
Whether the parser can handle the given tag.
Parameters
ctx
Returns
boolean