models

Documentation

Index

• type BookSearchResult
• type Config
• type Query
• type Reference
  • func (ref Reference) ToString() string
• type Version

Types

type BookSearchResult

type BookSearchResult struct {
	Name  string
	Index int
}

BookSearchResult stores the name of the book and the index of the last word in the tokenized string.

type Config

type Config struct {
	OwnerID          string   `yaml:"ownerID"`
	APIBible         string   `yaml:"apiBible"`
	IsDryRun         bool     `yaml:"dry"`
	AccessKey        string   `yaml:"accessKey"`
	LetsEncryptEmail string   `yaml:"letsEncryptEmail"`
	DecryptionKey    string   `yaml:"decryptionKey"`
	EncryptedFiles   []string `yaml:"encryptedFiles"`
}

Config is based off config.yml.

type Query

type Query struct {
	Token string `json:"token"`
	Body  string `json:"body"`
}

Query is a basic struct for the input we expect to receive.

type Reference

type Reference struct {
	Book            string
	StartingChapter int
	StartingVerse   int
	EndingChapter   int
	EndingVerse     int
	Version         Version

	IsOT  bool
	IsNT  bool
	IsDEU bool
}

Reference is a type for a verse reference, formulated after parsing.

func (Reference) ToString

func (ref Reference) ToString() string

ToString returns the reference in a string form.

type Version

type Version struct {
	Name                 string
	Abbreviation         string
	Source               string
	SupportsOldTestament bool
	SupportsNewTestament bool
	SupportsDeuterocanon bool
}

Version is a type describing a Bible version's properties.