jsonwalk

README

jsonwalk: a library to recursively traverse JSON structures

Documentation

Index

• Variables
• func FieldName(path string) string
• func Normalize(x interface{}) (interface{}, error)
• func Walk(structure interface{}, callback Walker, opts ...Option) error
• func WalkWithValues(structure interface{}, callback ValueWalker, opts ...Option) (interface{}, error)
• type Option
  • func WithRootPath(s string) Option
  • func WithoutArrayIndices() Option
• type Type
  • func TypeOf(x interface{}) (*Type, error)
  • func (t *Type) String() string
• type ValueWalker
• type Walker

Variables

var (
	Object = &Type{internalType("object")}
	Array  = &Type{internalType("array")}
	String = &Type{internalType("string")}
	Number = &Type{internalType("number")}
	Bool   = &Type{internalType("bool")}
	Null   = &Type{internalType("null")}
)

Functions

func FieldName

func FieldName(path string) string

func Normalize

func Normalize(x interface{}) (interface{}, error)

Normalize JSON object so that it is (shallowly) one of the basic JSON types.

func Walk

func Walk(structure interface{}, callback Walker, opts ...Option) error

func WalkWithValues

func WalkWithValues(structure interface{}, callback ValueWalker, opts ...Option) (interface{}, error)

Types

type Option

type Option func(*options) error

func WithRootPath

func WithRootPath(s string) Option

func WithoutArrayIndices

func WithoutArrayIndices() Option

type Type

type Type struct {
	// contains filtered or unexported fields
}

func TypeOf

func TypeOf(x interface{}) (*Type, error)

func (*Type) String

func (t *Type) String() string

type ValueWalker

type ValueWalker func(parentValue interface{}, path string, value interface{}) (interface{}, bool, error)

type Walker

type Walker func(path string, value interface{}) (bool, error)