Index

Modules: nimegenerator, nimegenerator/customconfigloader, nimegenerator/generator, nimegenerator/globals, nimegenerator/letters, nimegenerator/utils.

API symbols

addToDictionary:

• letters: addToDictionary(letters: seq[Letter])

cachedVowels:

• letters: cachedVowels

ConfigFile:

• customconfigloader: ConfigFile

defaultGenerationRules:

• globals: defaultGenerationRules

dictionary:

• letters: dictionary

doFormable:

• Operation.doFormable

doProbableLetter:

• Operation.doProbableLetter

Followed:

• letters: Followed

generateWord:

• generator: generateWord(): string

generateWordCustomRule:

• generator: generateWordCustomRule(tempRules: GenerationRules): string

generateWords:

• generator: generateWords(amount: Positive): seq[string]

generateWordsCustomRule:

• generator: generateWordsCustomRule(amount: Positive; tempRules: GenerationRules): seq[ string]

generateWordSubstringsWithCicles:

• letters: generateWordSubstringsWithCicles(cicles: Positive): seq[string]

generateWordWithCicles:

• letters: generateWordWithCicles(cicles: Positive): string

GenerationRules:

• globals: GenerationRules

getLetterFromChar:

• letters: getLetterFromChar(c: char): Letter

getNextLetter:

• letters: getNextLetter(curr: char): Letter
• letters: getNextLetter(curr: Letter): Letter
• letters: getNextLetter(word: string): Letter

getRandomLetter:

• letters: getRandomLetter(): Letter

getWordSubstringFromLetter:

• letters: getWordSubstringFromLetter(letter: Letter): string

JsonFollowed:

• customconfigloader: JsonFollowed

JsonLetter:

• customconfigloader: JsonLetter

Letter:

• letters: Letter

loadCustomConfigFromFile:

• customconfigloader: loadCustomConfigFromFile(filepath: string)

Operation:

• letters: Operation

Probability:

• globals: Probability

randomFrom:

• utils: randomFrom[T](sequence: seq[T]): T
• utils: randomFrom[T, Z](table: Table[T, Z]): Z

rules:

• globals: rules

setCustomGlobalRules:

• generator: setCustomGlobalRules(newRules: GenerationRules)