Wordnik
v1.0.1

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

hyphenation information about requested word

Wordnik Docs

Link to this section Summary

Types

hyphenation()

parsed JSON response to get_hyphenation/2 query

hyphenation_params()

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

Functions

get_hyphenation(word, params \\ %{})

get hyphenation for requested word

Link to this section Types

Link to this type

hyphenation()

View Source 
@type hyphenation() :: [
  %{optional(:type) => String.t(), text: String.t(), seq: integer()}
]

parsed JSON response to get_hyphenation/2 query

Link to this type

hyphenation_params()

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

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

Link to this section Functions

Link to this function

get_hyphenation(word, params \\ %{})

View Source 
@spec get_hyphenation(String.t(), hyphenation_params()) ::
  {:error, String.t()} | {:ok, hyphenation()}

get hyphenation for requested word

parameters

 Parameters

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

example

 Example 

iex> get_hyphenation("verbose", %{use_canonical})

response

 Response

Wordnik.Word.Hyphenation.hyphenation/0

wordnik-docs

 Wordnik Docs

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