api

package

v0.5.4 Latest Latest Go to latest Published: Nov 20, 2019 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/genuinetools/udict

Links

Open Source Insights

Documentation ¶

Index ¶

type Response
- func Define(word string) (response *Response, err error)
type Result

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Response ¶

type Response struct {
	Results []Result `json:"list"`
	Tags    []string `json:"tags"`
	Type    string   `json:"result_type"`
}

Response describes the data structure that comes back from the Urban Dictionary API.

func Define ¶

func Define(word string) (response *Response, err error)

Define returns the definitions from Urban Dictionary for a given word.

type Result ¶

type Result struct {
	ID         int64  `json:"defid"`
	Author     string `json:"author"`
	Definition string `json:"definition"`
	Link       string `json:"permalink"`
	ThumbsDown int64  `json:"thumbs_down"`
	ThumbsUp   int64  `json:"thumbs_up"`
	Word       string `json:"word"`
}

Result holds the information for a given definition.

Source Files ¶

View all Source files

api.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL