Wordnik
v1.0.1

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

pronunciation information for requested word

Wordnik Docs

Link to this section Summary

Types

pronunciations()

parsed JSON response to get_pronunciations/2 query

pronunciations_params()

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

Functions

get_pronunciations(word, params \\ %{})

get pronunciations for requested word

Link to this section Types

Link to this type

pronunciations()

View Source 
@type pronunciations() :: [
  %{
    optional(:id) => String.t(),
    optional(:attributionText) => String.t(),
    optional(:attributionUrl) => String.t(),
    seq: integer(),
    raw: String.t(),
    rawType: String.t()
  }
]

parsed JSON response to get_pronunciations/2 query

Link to this type

pronunciations_params()

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

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

Link to this section Functions

Link to this function

get_pronunciations(word, params \\ %{})

View Source 
@spec get_pronunciations(String.t(), pronunciations_params()) ::
  {:error, String.t()} | {:ok, pronunciations()}

get pronunciations for requested word

parameters

 Parameters

  • use_canonical: boolean
  • limit: integer
  • type_format: string
  • source_dict: string

example

 Example 

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

response

 Response

Wordnik.Word.Pronunciations.pronunciations/0

wordnik-docs

 Wordnik Docs

https://developer.wordnik.com/docs#!/word/getTextPronunciations