urbandictionary

README

urbandictionary

Urban Dictionnary API wrapper in golang

Documentation

Index

• Constants
• type Result
• type SearchResult
  • func Query(searchTerm string) (*SearchResult, error)

Constants

const UrbanDictionaryAPI = "http://api.urbandictionary.com/v0/define?term="

UrbanDictionaryAPI contains the Urban Dictionary API URL for search results

Types

type Result

type Result struct {
	Author       string    `json:"author"`
	CurrentVote  string    `json:"current_vote"`
	Date         time.Time `json:"-"`
	Definition   string    `json:"definition"`
	DefinitionID int       `json:"defid"`
	Example      string    `json:"example"`
	Permalink    string    `json:"permalink"`
	ThumbsUp     int       `json:"thumbs_up"`
	ThumbsDown   int       `json:"thumbs_down"`
	Word         string    `json:"word"`

	WrittenOn string `json:"written_on"`
}

Result contains data regarding an Urban Dictionary definition

type SearchResult

type SearchResult struct {
	Results []Result `json:"list"`
}

SearchResult contains data regarding an Urban Dictionary search result

func Query

func Query(searchTerm string) (*SearchResult, error)

Query returns data from an Urban Dictionary search result