search

Documentation

Overview

Package search provides an index that allows searching through xkcd comic metadata.

Index

• func Close() error
• func Index(comic *xkcd.Comic) error
• func Init() (err error)
• func Search(userQuery string) (*bleve.SearchResult, error)

Functions

func Close

func Close() error

Close closes the search index.

func Index

func Index(comic *xkcd.Comic) error

Index adds comic to the search index.

func Init

func Init() (err error)

Init initializes the search index.

func Search

func Search(userQuery string) (*bleve.SearchResult, error)

Search searches the index for the given userQuery.