Wordnik
v1.0.1

View Source Wordnik.Word.RelatedWords (Wordnik v1.0.1)

find related words organized by type of relationship (synonym, antonym, etc.)

Wordnik Docs

Link to this section Summary

Types

related_words()

parsed JSON response to get_related_words/2 query

related_words_params()

map of optional parameters that can be passed to get_related_words/2 query

Functions

get_related_words(word, params \\ %{})

get related_words for requested word

Link to this section Types

Link to this type

related_words()

View Source 
@type related_words() :: [%{relationshipType: String.t(), words: [String.t()]}]

parsed JSON response to get_related_words/2 query

Link to this type

related_words_params()

View Source 
@type related_words_params() :: %{
  optional(:use_canonical) => boolean(),
  optional(:limit) => integer(),
  optional(:relationship_types) => Formatter.Enums.relationship_types()
}

map of optional parameters that can be passed to get_related_words/2 query

Link to this section Functions