randword

package

v0.0.0-...-1ee3c8e Latest Latest Go to latest Published: Jan 13, 2023 License: Apache-2.0 Imports: 8 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

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

This section is empty.

This section is empty.

This section is empty.

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

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

func NewClient(baseURL string) *Client

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

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

Adjective requests a random adjective.

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

Animal requests a random animal name.

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

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

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

Noun requests a random noun.