View Source Dictionary (defdo_dictionary v0.1.0)
The Dictionary module provides a way to interact with words files.
Currently we use a popular.txt file as default, but you can bring your own file.
At this stage you can use it to create your slugs based on the provided words.
Link to this section Summary
Functions
Give the application dictionary path to get the popular.txt file.
Get a random slug using the words provided.
Get a random word using the words provided.
Start a list of words, if you provide a file with the new dictionary It will load to the memory instead, by default it uses a popular dictionary.
Link to this section Types
@opaque path()
@opaque slug()
@opaque t()
@opaque word()
Link to this section Functions
@spec popular_dictionary_path() :: path()
Give the application dictionary path to get the popular.txt file.
Get a random slug using the words provided.
Get a random word using the words provided.
@spec start() :: t()
Start a list of words, if you provide a file with the new dictionary It will load to the memory instead, by default it uses a popular dictionary.
@spec start(Dictionary.Impl.WordList.file()) :: t()