search

Documentation

Index

• Constants
• type SearchParams
• type Searcher

Constants

const DefaultLimit = 24

Types

type SearchParams

type SearchParams struct {
	Term string
}

type Searcher

type Searcher interface {
	// SearchDocs is used to search the index. It is passed a query and the max number
	// of results to return.
	// If limit is 0, the default limit is used.
	// A slice of post ids is returned
	SearchDocs(ctx context.Context, params SearchParams) (paths []string, err error)

	// IndexDocs indexes the entire docs directory
	// The argument of the function is the directory to index
	// This should clear all previous indexe
	IndexDocs(ctx context.Context, store fs.FS) error
}