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

phrases that include the selected word

Link to this section Summary

phrases()

parsed JSON response to get_phrases/2 query

phrases_params()

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

get phrases for requested word

@type phrases() :: [
  %{
    count: integer(),
    gram1: String.t(),
    gram2: String.t(),
    mi: integer(),
    wlmi: integer()
  }
]

parsed JSON response to get_phrases/2 query

@type phrases_params() :: %{
  optional(:use_canonical) => boolean(),
  optional(:limit) => integer(),
  optional(:wlmi) => integer()
}

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

@spec get_phrases(String.t(), phrases_params()) ::
  {:error, String.t()} | {:ok, phrases()}

get phrases for requested word

iex> get_phrases("verbose", %{use_canonical: true, limit: 5})