README
¶
jokeapi-go
Official golang wrapper for Sv443's jokeapi.
Install-
Add github.com/icelain/jokeapito your go.mod(recommended) or:
EXPORT GO11MODULE=off
go get -u github.com/icelain/jokeapi
Basic Usage Without Parameters-
import "github.com/icelain/jokeapi"
func main(){
api := jokeapi.New()
response, err := api.Fetch()
}
Response Struct-
type JokesResp struct{
Error bool
Category string
JokeType string
Joke []string
Flags map[string] bool
Id float64
Lang string
}
Usage with all parameters-
import "github.com/icelain/jokeapi"
func main(){
jt := "single"
blacklist := []string{"nsfw"}
ctgs := []string{"Programming","Dark"}
api:= jokeapi.New()
api.Set(jokeapi.Params{Blacklist: blacklist, JokeType: jt, Categories: ctgs})
response, err := api.Fetch()
}
Config struct-
api.Set(jokeapi.Params{})
Config methods-
api.SetBlacklist(blacklist)
api.SetCategories(ctgs)
api.SetJokeType(joketype)
api.SetLang(language)
Documentation
¶
Index ¶
- type JokeAPI
- func (j *JokeAPI) Fetch() (JokesResp, error)
- func (j *JokeAPI) FetchWithContext(ctx context.Context) (JokesResp, error)
- func (j *JokeAPI) Set(params Params)
- func (j *JokeAPI) SetBlacklist(b []string)
- func (j *JokeAPI) SetCategories(ctgs []string)
- func (j *JokeAPI) SetJokeType(s string)
- func (j *JokeAPI) SetLang(lang string)
- func (j *JokeAPI) SetParams(ctgs []string, blacklist []string, joketype string, lang string)
- type JokesResp
- type Params
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type JokeAPI ¶
type JokeAPI struct {
ExportedParams Params
}
JokeAPI struct
func (*JokeAPI) Fetch ¶
Fetch gets the content with respect to the parameters. Use FetchWithContext to add your custom context.
func (*JokeAPI) FetchWithContext ¶
FetchWithContext gets the content with respect to the parameters. Accepts a context.Context.
func (*JokeAPI) SetBlacklist ¶
SetBlacklist sets joke blacklist. Common blacklists are nsfw | religious | political | racist | sexist | explicit
func (*JokeAPI) SetCategories ¶
SetCategories sets joke categories. Common categories are Programming | Misc | Spooky | Dark | Fun
func (*JokeAPI) SetLang ¶
SetLang sets language. Go to https://v2.jokeapi.dev/languages?format=txt to select your preferable language format. By default its en (English). Note that (as of now) most jokes are available in en and de only and setting other languages will give a corresponding error
Source Files