View Source Wordnik.Word.TopExample (Wordnik v1.0.1)
find top-rated example for requested word
Link to this section Summary
Types
map of optional parameters that can be passed to get_top_example/2 query
Functions
get top_example for requested word
Link to this section Types
@type top_example_params() :: %{optional(:use_canonical) => boolean()}
map of optional parameters that can be passed to get_top_example/2 query
Link to this section Functions
@spec get_top_example(String.t(), top_example_params()) :: {:error, String.t()} | {:ok, Word.Examples.example()}
get top_example for requested word
parameters
Parameters
- use_canonical: boolean
example
Example
iex> get_top_example("verbose", %{use_canonical: true})
response
Response
Wordnik.Word.Examples.example/0