parser

Documentation

Index

• func Parse(query string, options ...Option) (ast.Expression, error)
• type Option
  • func WithFunctions(fns map[ast.FunctionID]*ast.FunctionDefinition) Option
  • func WithParamNodes() Option
  • func WithParams(p groq.Params) Option
  • func WithVersion(v Version) Option
• type ParseError
• type Version

Functions

func Parse

func Parse(query string, options ...Option) (ast.Expression, error)

Types

type Option

type Option func(*parserOpts)

func WithFunctions

func WithFunctions(fns map[ast.FunctionID]*ast.FunctionDefinition) Option

func WithParamNodes

func WithParamNodes() Option

func WithParams

func WithParams(p groq.Params) Option

func WithVersion

func WithVersion(v Version) Option

type ParseError

type ParseError interface {
	error
	Message() string
	Pos() ast.Position
}

ParseError represents an error during parsing.

type Version

type Version int

var (
	// VersionGROQ1 targets GROQ-1: https://sanity-io.github.io/GROQ/.
	VersionGROQ1 Version = 2

	// VersionLegacyGROQ targets the legacy version of GROQ implemented by Sanity.io.
	VersionLegacyGROQ Version = 1

	// Version1 is an alias for VersionLegacyGROQ.
	// Deprecated: Use VersionLegacyGROQ.
	Version1 Version = 1

	// Version2 is an alias for VersionGROQ1.
	// Deprecated: Use VersionGROQ1.
	Version2 Version = 2
)