Class: StopParser
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
Extends
Implements
Constructors
new StopParser()
new StopParser(): StopParser
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: Context
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: Context
Returns
boolean