ost

Documentation

Index

• Constants
• type Client
  • func New(ctx context.Context) (*Client, error)
  • func (c *Client) Today(opts ...Option) (string, error)
  • func (c *Client) TodayHTML(opts ...Option) (template.HTML, error)
  • func (c *Client) TodayPhoto(opts ...Option) (*photo.Info, error)
  • func (c *Client) TodayVerse(opts ...Option) (*Verse, error)
• type Option
  • func On(t time.Time) Option
• type Verse
• type Version

Constants

const DefaultBaseURL = `https://openscripture.today`

Types

type Client

type Client struct {
	Client       *http.Client
	TextService  *text.Service
	PhotoService *photo.Service
	BaseURL      string
}

func New

func New(ctx context.Context) (*Client, error)

func (*Client) Today

func (c *Client) Today(opts ...Option) (string, error)

func (*Client) TodayHTML

func (c *Client) TodayHTML(opts ...Option) (template.HTML, error)

func (*Client) TodayPhoto

func (c *Client) TodayPhoto(opts ...Option) (*photo.Info, error)

func (*Client) TodayVerse

func (c *Client) TodayVerse(opts ...Option) (*Verse, error)

type Option

type Option func(*options)

func On

func On(t time.Time) Option

type Verse

type Verse struct {
	Reference string        `yaml:"reference"`
	Content   template.HTML `yaml:"content"`
	Version
}

Verse is the metadata and content for a verse of the day.

type Version

type Version struct {
	Name string `yaml:"name"`
	Link string `yaml:"link"`
}

Version is the metadata for the version of the Bible used for the verse.