StopParser
Class: StopParser
Defined in: packages/tagscript/src/lib/Parsers/Stop.ts:20
The stop tag stops tag processing if the given parameter is true. If a message is passed to the payload it will return that message.
Aliases: halt, stop
Example
{stop({args}!=10):You didn't provided valid input.}Extends
Implements
Constructors
Constructor
new StopParser(): StopParser
Defined in: packages/tagscript/src/lib/Parsers/Stop.ts:21
Returns
StopParser
Overrides
Properties
acceptedNames
protected acceptedNames: string[]
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:8
Inherited from
requiredParameter
protected requiredParameter: boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:10
Inherited from
requiredPayload
protected requiredPayload: boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:12
Inherited from
Methods
parse()
parse(ctx): string
Defined in: packages/tagscript/src/lib/Parsers/Stop.ts:25
Parses the given tag.
Returning null or undefined means this parser did not handle the tag, and the interpreter
moves on to the next one that accepted it.
Parameters
ctx
The context of the tag.
Returns
string
Implementation of
toJSON()
toJSON(): object
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:29
Returns
object
acceptedNames
acceptedNames: string[]
requiredParameter
requiredParameter: boolean
requiredPayload
requiredPayload: boolean
Inherited from
willAccept()
willAccept(ctx): boolean
Defined in: packages/tagscript/src/lib/Parsers/Base.ts:20
Whether the parser can handle the given tag.
Parameters
ctx
Returns
boolean