Tagscript

tagscript


Class: SliceParser

Defined in: Parsers/Slice.ts:19

Parser for the slice tag. This tag will take a string and return a substring of it.

Aliases: slice, substr, substring

Example

{slice(3): Hello World}
{slice(3, 7): Hello World}
{slice(3-7): Hello World}

Extends

Implements

Constructors

new SliceParser()

new SliceParser(): SliceParser

Defined in: Parsers/Slice.ts:20

Returns

SliceParser

Overrides

BaseParser.constructor

Properties

acceptedNames

protected acceptedNames: string[]

Defined in: Parsers/Base.ts:8

Inherited from

BaseParser.acceptedNames


requiredParameter

protected requiredParameter: boolean

Defined in: Parsers/Base.ts:10

Inherited from

BaseParser.requiredParameter


requiredPayload

protected requiredPayload: boolean

Defined in: Parsers/Base.ts:12

Inherited from

BaseParser.requiredPayload

Methods

parse()

parse(ctx): string

Defined in: Parsers/Slice.ts:24

Parses the given tag.

Parameters

ctx

Context

The context of the tag.

Returns

string

Implementation of

IParser.parse


toJSON()

toJSON(): object

Defined in: Parsers/Base.ts:29

Returns

object

acceptedNames

acceptedNames: string[]

requiredParameter

requiredParameter: boolean

requiredPayload

requiredPayload: boolean

Inherited from

BaseParser.toJSON


willAccept()

willAccept(ctx): boolean

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