search

Documentation

Index

• func Include(rank int) bool
• func Match(q, val string) int
• func Register(searchType SearchType, search func(ctx context.Context, q string) []*Result)
• type Result
• type SearchFilter
• type SearchNode
• type SearchNodeConnection
  • func Search(ctx context.Context, page *pagination.Pagination, filter SearchFilter) (*SearchNodeConnection, error)
• type SearchNodeEdge
• type SearchType
  • func (e SearchType) MarshalGQL(w io.Writer)
  • func (e SearchType) String() string
  • func (e *SearchType) UnmarshalGQL(v interface{}) error
• type Searchers

Functions

func Include

func Include(rank int) bool

func Match

func Match(q, val string) int

Match returns the rank of a match between q and val. 0 means best match. -1 means no match.

func Register

func Register(searchType SearchType, search func(ctx context.Context, q string) []*Result)

Types

type Result

type Result struct {
	Node SearchNode
	Rank int
}

type SearchFilter

type SearchFilter struct {
	Query string      `json:"query"`
	Type  *SearchType `json:"type,omitempty"`
}

type SearchNode

type SearchNode interface {
	IsSearchNode()
}

type SearchNodeConnection

type SearchNodeConnection = pagination.Connection[SearchNode]

func Search

func Search(ctx context.Context, page *pagination.Pagination, filter SearchFilter) (*SearchNodeConnection, error)

type SearchNodeEdge

type SearchNodeEdge = pagination.Edge[SearchNode]

type SearchType

type SearchType string

func (SearchType) MarshalGQL

func (e SearchType) MarshalGQL(w io.Writer)

func (SearchType) String

func (e SearchType) String() string

func (*SearchType) UnmarshalGQL

func (e *SearchType) UnmarshalGQL(v interface{}) error

type Searchers

type Searchers struct {
	Search func(ctx context.Context, q string) []*Result
	Type   SearchType
}