Wordnik
v1.0.1

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

frequency of usage across years for the requested word

Wordnik Docs

Link to this section Summary

Types

frequency()

parsed JSON response to get_frequency/2 query

frequency_params()

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

Functions

get_frequency(word, params \\ %{})

get frequency for requested word

Link to this section Types

Link to this type

frequency()

View Source 
@type frequency() :: %{
  frequency: [%{year: String.t(), count: integer()}],
  frequencyString: String.t(),
  totalCount: integer(),
  unknownYearCount: integer(),
  word: String.t()
}

parsed JSON response to get_frequency/2 query

Link to this type

frequency_params()

View Source 
@type frequency_params() :: %{
  optional(:start_year) => integer(),
  optional(:end_year) => integer(),
  optional(:use_canonical) => boolean()
}

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

Link to this section Functions

Link to this function

get_frequency(word, params \\ %{})

View Source 
@spec get_frequency(String.t(), frequency_params()) ::
  {:error, String.t()} | {:ok, frequency()}

get frequency for requested word

parameters

 Parameters

  • use_canonical: boolean
  • start_year: integer
  • end_year: integer

example

 Example 

iex> get_frequency("verbose", %{ use_canonical: true, start_year: 1990, end_year: 2000 })

response

 Response

Wordnik.Word.Frequency.frequency/0

wordnik-docs

 Wordnik Docs

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