Botfuel

v0.1.0

Botfuel v0.1.0 Botfuel.Entity View Source

Link to this section Summary

Types

dimension()
t()

Functions

purify(params, field)

Check the provided parameters and field against the set of all possible dimensions. It returns a purified %Botfuel.Entity{} from bad user input

Link to this section Types

Link to this type dimension() View Source 
dimension() ::
  :street_number
  | :street_type
  | :postal
  | :city
  | :country
  | :address
  | :language
  | :nationality
  | :email
  | :hashtag
  | :number
  | :ordinal
  | :time
  | :duration
  | :distance
  | :area
  | :volume
  | :temperature
  | :forename
  | :family
  | :percentage
  | :url
  | :item_count
  | :currency
  | :money
  | :color
Link to this type t() View Source 
t() :: %Botfuel.Entity{
  antidimensions: [dimension()],
  case_sensitive: boolean(),
  dimensions: [dimension()],
  keep_accents: boolean(),
  keep_quotes: boolean(),
  sentence: String.t(),
  timezone: String.t()
}

Link to this section Functions

Link to this function purify(params, field) View Source 
purify(Botfuel.Entity.t(), atom()) :: map()

Check the provided parameters and field against the set of all possible dimensions. It returns a purified %Botfuel.Entity{} from bad user input.