api

Documentation

Index

• func Search(expression string, data interface{}, funcs ...functions.FunctionEntry) (interface{}, error)
• type JMESPath
  • func Compile(expression string, funcs ...functions.FunctionEntry) (JMESPath, error)
  • func MustCompile(expression string, funcs ...functions.FunctionEntry) JMESPath

Functions

func Search

func Search(expression string, data interface{}, funcs ...functions.FunctionEntry) (interface{}, error)

Search evaluates a JMESPath expression against input data and returns the result.

Types

type JMESPath

type JMESPath interface {
	Search(interface{}) (interface{}, error)
}

JMESPath is the representation of a compiled JMES path query. A JMESPath is safe for concurrent use by multiple goroutines.

func Compile

func Compile(expression string, funcs ...functions.FunctionEntry) (JMESPath, error)

Compile parses a JMESPath expression and returns, if successful, a JMESPath object that can be used to match against data.

func MustCompile

func MustCompile(expression string, funcs ...functions.FunctionEntry) JMESPath

MustCompile is like Compile but panics if the expression cannot be parsed. It simplifies safe initialization of global variables holding compiled JMESPaths.