utils

Documentation

Index

• type Metadata
• type Story
  • func NewStoryFromFile(filePath string) (Story, error)
  • func NewStoryFromPath(path string) (Story, error)
  • func NewStoryFromText(text []byte) (Story, error)
  • func NewStoryFromURL(url string) (Story, error)
  • func (s *Story) Generate() (string, error)
  • func (s *Story) Init() error
  • func (s *Story) Upload(bucket, prefix string) (*Story, error)

Types

type Metadata

type Metadata struct {
	Type     string
	Template string
}

Metadata describes the configuration of a story

type Story

type Story struct {
	Meta Metadata
	Data map[string]interface{}
	// contains filtered or unexported fields
}

Story is metadata plus a set of variable chunks

func NewStoryFromFile

func NewStoryFromFile(filePath string) (Story, error)

NewStoryFromFile loads a new Story generator from a config file

func NewStoryFromPath

func NewStoryFromPath(path string) (Story, error)

NewStoryFromPath loads a new story generator from a file or URL

func NewStoryFromText

func NewStoryFromText(text []byte) (Story, error)

NewStoryFromText loads a new Story generator from a string

func NewStoryFromURL

func NewStoryFromURL(url string) (Story, error)

NewStoryFromURL loads a new Story generator from a URL to a config file

func (*Story) Generate

func (s *Story) Generate() (string, error)

Generate creates a story string

func (*Story) Init

func (s *Story) Init() error

Init sets up initial state for the Story object

func (*Story) Upload

func (s *Story) Upload(bucket, prefix string) (*Story, error)

Upload copies a story into S3