Class TagSystemRuleSetBuilder

A builder to build the tag system's ruleset.

See

TagSystemRuleSet

Index

Constructors

Properties

Methods

add addStop build hasNotUndefined

Constructors

constructor

new TagSystemRuleSetBuilder(): TagSystemRuleSetBuilder
Returns TagSystemRuleSetBuilder

Properties

`Private` rules

rules: Map<TagSystemLetter, undefined | TagSystemRuleOutput> = ...

Methods

add

add(firstLetter, writeWord): TagSystemRuleSetBuilder
Add rule to this builder.
Parameters
- firstLetter: TagSystemLetter
- writeWord: TagSystemLetter[]
Returns TagSystemRuleSetBuilder
This builder, to method chains.

Remarks
The rule is interpreted as "When the first letter of a word is firstLetter, add writeWord after the word and delete the first m letters." m is set by TagSystem.

Throws
If a rule with the same "firstLetter" has already been added.
- Defined in tag-system.ts:173

addStop

addStop(firstLetter): TagSystemRuleSetBuilder
Add STOP rule to this builder.
Parameters
- firstLetter: TagSystemLetter
Returns TagSystemRuleSetBuilder
This builder, to method chains.

Remarks
The rule is interpreted as "When the first letter of a word is firstLetter, this tag system stops working."

Throws
If a rule with the same "firstLetter" has already been added.
- Defined in tag-system.ts:203

build

build(): TagSystemRuleSet
Build the rule-set with the configured rules.

Returns TagSystemRuleSet
Created rule-set.

Remarks
When calling this function, only one rule must be defined for each character. Otherwise, it throws an error.
- Defined in tag-system.ts:239

`Private` hasNotUndefined

hasNotUndefined(map): map is Map<TagSystemLetter, TagSystemRuleOutput>
Parameters
- map: Map<TagSystemLetter, undefined | TagSystemRuleOutput>
Returns map is Map<TagSystemLetter, TagSystemRuleOutput>
- Defined in tag-system.ts:215

Generated using TypeDoc