tagscript

Class: StopParser

Defined in: Parsers/Stop.ts:19

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

• BaseParser

Implements

• IParser

Constructors

new StopParser()

Defined in: Parsers/Stop.ts:20

Returns

StopParser

Overrides

BaseParser.constructor

Properties

acceptedNames

Defined in: Parsers/Base.ts:8

Inherited from

BaseParser.acceptedNames

requiredParameter

Defined in: Parsers/Base.ts:10

Inherited from

BaseParser.requiredParameter

requiredPayload

Defined in: Parsers/Base.ts:12

Inherited from

BaseParser.requiredPayload

Methods

parse()

Defined in: Parsers/Stop.ts:24

Parses the given tag.

Parameters

ctx

Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

toJSON()

Defined in: Parsers/Base.ts:29

Returns

object

acceptedNames

requiredParameter

requiredPayload

Inherited from

BaseParser.toJSON

willAccept()

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