Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

api

package

Go to main page

Versions in this module

v0

v0.8.0

Jan 30, 2025

v0.7.0

Jan 28, 2025

v0.6.0

Jan 24, 2025

v0.5.0

Jan 20, 2025

v0.4.0

Jan 15, 2025

v0.3.0

Jan 8, 2025

v0.2.0

Dec 18, 2024

v0.1.0

Dec 6, 2024

Changes in this version

+ var ErrNotAPointer = errors.New("result must be a pointer")

+ func Create[E CreatableEntity](ctx context.Context, client Client, customAttributes string, input AddInput) (map[string]any, error)

+ func Decode(input, output any) error

+ func DecodeInterface(input GraphQLInterface, output any) error

+ func Delete[E DeletableEntity](ctx context.Context, client Client, id string) (string, error)

+ func FormatAttributes(attr string, offset int) string

+ func List[E ListableEntity](ctx context.Context, client Client, customAttributes string, getAll bool, ...) ([]map[string]any, error)

+ func ParseAttributes[Entity any](options ...ParseOption) string

+ func Read[E ReadableEntity](ctx context.Context, client Client, customAttributes, id string) (map[string]any, error)

+ func StructuredCreate[E CreatableEntity, ReturnStruct any](ctx context.Context, client Client, customAttributes string, input AddInput) (ReturnStruct, error)

+ func StructuredList[E ListableEntity, ReturnStruct any](ctx context.Context, client Client, customAttributes string, getAll bool, ...) ([]ReturnStruct, error)

+ func StructuredRead[E ReadableEntity, ReturnStruct any](ctx context.Context, client Client, customAttributes, id string) (ReturnStruct, error)

+ type AddInput interface

+ Input func() (map[string]any, error)

+ type Client interface

+ Logger func() *slog.Logger

+ Query func(ctx context.Context, query string, variables map[string]any) (map[string]any, error)

+ type CreatableEntity interface

+ CreateQueryString func(customAttributes string) string

+ CreateResponseField func() string

+ DefaultProperties func() string

+ type Defaults interface

+ DefaultOrderBy func() (string, bool)

+ DefaultOrderMode func() (string, bool)

+ DefaultPageSize func() (int, bool)

+ type DeletableEntity interface

+ DeleteQueryString func() string

+ DeleteResponseField func() string

+ type EditInput struct

+ Key string

+ ObjectPath string

+ Operation EditOperation

+ Value any

+ type EditOperation string

+ const EditOperationAdd

+ const EditOperationRemove

+ const EditOperationReplace

+ type File struct

+ Data []byte

+ MIME string

+ Name string

+ type GraphQLInterface interface

+ Implementations func() []reflect.Type

+ Remainder func() map[string]any

+ type InterfaceTypeError struct

+ Received reflect.Type

+ Want reflect.Kind

+ func (err InterfaceTypeError) Error() string

+ type ListableEntity interface

+ DefaultProperties func() string

+ ListQueryString func(customAttributes string) string

+ ListResponseField func() string

+ type MissingFieldError struct

+ FieldName string

+ func (err MissingFieldError) Error() string

+ type NotImplementingError struct

+ ImplementationType reflect.Type

+ InterfaceType reflect.Type

+ func (e NotImplementingError) Error() string

+ type ParseOption func(p *attributeParser)

+ func WithComments(comments bool) ParseOption

+ func WithMaxDepth(maxDepth int) ParseOption

+ type ReadableEntity interface

+ DefaultProperties func() string

+ ReadQueryString func(customAttributes string) string

+ ReadResponseField func() string

+ type TypeAssertionError struct

+ ExpectedType string

+ Variable any

+ func (err TypeAssertionError) Error() string

+ type UnimplementedDecodingError struct

+ func (e UnimplementedDecodingError) Error() string