Tagscript

tagscript


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

{stop({args}!=10):You didn't provided valid input.}

Extends

Implements

Constructors

new StopParser()

new StopParser(): StopParser

Returns

StopParser

Overrides

BaseParser.constructor

Defined in

Parsers/Stop.ts:20

Properties

acceptedNames

protected acceptedNames: string[]

Inherited from

BaseParser.acceptedNames

Defined in

Parsers/Base.ts:8


requiredParameter

protected requiredParameter: boolean

Inherited from

BaseParser.requiredParameter

Defined in

Parsers/Base.ts:10


requiredPayload

protected requiredPayload: boolean

Inherited from

BaseParser.requiredPayload

Defined in

Parsers/Base.ts:12

Methods

parse()

parse(ctx): string

Parses the given tag.

Parameters

ctx

Context

The context of the tag.

Returns

string

Implementation of

IParser.parse

Defined in

Parsers/Stop.ts:24


toJSON()

toJSON(): object

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON

Defined in

Parsers/Base.ts:29


willAccept()

willAccept(ctx): boolean

Whether the parser can handle the given tag.

Parameters

ctx

Context

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept

Defined in

Parsers/Base.ts:20