xkcd

README

xkcd - XKCD library for Go

Example usage

package main

import (
	"fmt"
	"log"

	"github.com/1nter-p/xkcd"
)

func main() {
	// Get the comic with number 327 (Exploits of a Mom/"Bobby Tables")
	c, err := xkcd.ComicFromNum(327)
	if err != nil {
		log.Fatal(err)
	}

	// Print the title and alt text
	fmt.Println("Title:", c.Title)
	fmt.Println(c.Alt)
}

Documentation

Index

• type Comic
  • func ComicFromNum(num int) (Comic, error)
  • func ComicFromURL(url string) (Comic, error)
  • func LatestComic() (Comic, error)
  • func RandomComic() (Comic, error)

Types

type Comic

type Comic struct {
	Number     int    `json:"num"`
	Title      string `json:"title"`
	SafeTitle  string `json:"safe_title"`
	Alt        string `json:"alt"`
	ImageURL   string `json:"img"`
	Link       string `json:"link"`
	News       string `json:"news"`
	Transcript string `json:"transcript"`
	Year       string `json:"year"`
	Month      string `json:"month"`
	Day        string `json:"day"`
}

func ComicFromNum

func ComicFromNum(num int) (Comic, error)

ComicFromNum creates a new Comic from the given comic number/ID.

func ComicFromURL

func ComicFromURL(url string) (Comic, error)

ComicFromURL creates a new Comic from the given comic URL (info.0.json).

func LatestComic

func LatestComic() (Comic, error)

LatestComic returns the latest comic as a Comic object.

func RandomComic

func RandomComic() (Comic, error)

RandomComic returns a random comic as a Comic object.