RangeParser

Class: RangeParser

Defined in: Parsers/Range.ts:27

The range tag picks a random number from a range of numbers separated by - or ,. Both ends are included, so {range:1-6} can return 1 and can return 6. The rangef tag picks a number to one decimal place instead.

Aliases: rangef

Examples

{range:1-3}

Your lucky number is {range:10-30}!
# Your lucky number is 14!
# Your lucky number is 25!
{=(height):{rangef:5-7}}
I am guessing your height is {height}ft.
# I am guessing your height is 5.3ft.

Extends

BaseParser

Implements

IParser

Constructors

Constructor

new RangeParser(): RangeParser

Defined in: Parsers/Range.ts:28

Returns

RangeParser

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/Range.ts:32

Parses the given tag.

Parameters

ctx

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

Returns

boolean

Implementation of

IParser.willAccept

Inherited from

BaseParser.willAccept