randword

Documentation

Overview

Package randword provides a client to the random word generator API.

Index

• type Client
  • func NewClient(baseURL string) *Client
  • func (c *Client) Adjective() (string, error)
  • func (c *Client) Animal() (string, error)
  • func (c *Client) HumanReadableSlug() (string, error)
  • func (c *Client) Noun() (string, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is an HTTP client for a random word generator API.

func NewClient

func NewClient(baseURL string) *Client

NewClient constructs a new client that is configured to use the given endpoint specified by baseURL.

func (*Client) Adjective

func (c *Client) Adjective() (string, error)

Adjective requests a random adjective.

func (*Client) Animal

func (c *Client) Animal() (string, error)

Animal requests a random animal name.

func (*Client) HumanReadableSlug

func (c *Client) HumanReadableSlug() (string, error)

HumanReadableSlug returns a randomly generated URL slug comprised of hyphen-separated words.

func (*Client) Noun

func (c *Client) Noun() (string, error)

Noun requests a random noun.