View Source Dictionary.Impl.WordList (defdo_dictionary v0.1.0)

Retrieve the word list by default it used de popular words from.

Link to this section Summary

Functions

Get a random slug using the words provided.

Get a random word using the words provided.

Returns 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

Link to this section Functions

Link to this function

random_slug(words, size)

View Source
@spec random_slug(t(), number_of_words :: integer() | struct()) :: slug()

Get a random slug using the words provided.

@spec random_word(t()) :: word()

Get a random word using the words provided.

Link to this function

word_list(file \\ popular_dictionary_path())

View Source
@spec word_list(file()) :: t()

Returns 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.