search

package

v0.2.0 Latest Latest Go to latest Published: May 19, 2026 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/fromforgesoftware/forge

Links

Open Source Insights

Documentation ¶

Overview ¶

Package search composes the Query DSL (filter / sort / fieldsets / includes / pagination) into the search.Option callbacks every kit repository / list endpoint consumes.

Index ¶

Constants
type Option
- func WithQuery(q query.Query) Option
- func WithQueryOpts(opts ...query.Option) Option
- func (o Option) Equal(another Option) bool
type Search
- func New(opts ...Option) Search

Constants ¶

View Source

const (
	FieldNameSearch  string = "search"
	FieldNameOptions string = "options"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Option ¶

type Option func(s *search)

func WithQuery ¶

func WithQuery(q query.Query) Option

func WithQueryOpts ¶

func WithQueryOpts(opts ...query.Option) Option

func (Option) Equal ¶

func (o Option) Equal(another Option) bool

type Search ¶

type Search interface {
	Query() query.Query
	Equal(another Search) bool
}

func New ¶

func New(opts ...Option) Search

Source Files ¶

View all Source files

search.go

Directories ¶

Path	Synopsis
query Package query is the search Query DSL — filter operators, sort expressions, sparse fieldsets, includes, and pagination styles — shared by every REST + gRPC list endpoint in go/kit.	Package query is the search Query DSL — filter operators, sort expressions, sparse fieldsets, includes, and pagination styles — shared by every REST + gRPC list endpoint in go/kit.
querytest Package querytest provides test helpers for query options	Package querytest provides test helpers for query options
searchtest Package searchtest provides tools to test search options, queries, etc	Package searchtest provides tools to test search options, queries, etc

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL