Class TagSystemRuleSet

The tag system's program.

Remarks

You should use TagSystemRuleSet.builder to construct this.

Index

Constructors

Properties

rules usedLetters

Methods

getAllUsedLetters getCandinates toString builder

Constructors

constructor

new TagSystemRuleSet(rules): TagSystemRuleSet
Construct TagSystemRuleset with given rules.
Parameters
- rules: Map<TagSystemLetter, TagSystemRuleOutput>
  list of rule.
Returns TagSystemRuleSet
Remarks
This method is used by the library. You must use TagSystemRuleSet.builder.
- Defined in tag-system.ts:92

Properties

`Private` `Readonly` rules

rules: Map<TagSystemLetter, TagSystemRuleOutput>

`Private` `Readonly` usedLetters

usedLetters: Set<TagSystemLetter>

Methods

getAllUsedLetters

getAllUsedLetters(): Set<TagSystemLetter>
Returns all letters that this rule uses.

Returns Set<TagSystemLetter>
set of the letters
- Defined in tag-system.ts:124

getCandinates

getCandinates(firstLetter): TagSystemRuleOutput
Returns what kind of change occurred in the tag system when the given letter.
Parameters
- firstLetter: TagSystemLetter
  first character of the word being processed.
Returns TagSystemRuleOutput
what indicates kind of change
- Defined in tag-system.ts:113

toString

toString(): string
Returns string representation of this ruleset.

Returns string
string representation of this ruleset
- Defined in tag-system.ts:132

`Static` builder

builder(): TagSystemRuleSetBuilder
Create builder for TagSystemRuleSet.

Returns TagSystemRuleSetBuilder
Created builder.
- Defined in tag-system.ts:76

Generated using TypeDoc