graphqlutil

Documentation

Overview

Package graphqlutil provides utilities for working with GraphQL.

Index

• Variables
• func WrapTransport(t http.RoundTripper) http.RoundTripper
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Is(target error) bool
• type ErrorList
  • func (e ErrorList) Error() string
  • func (e ErrorList) Unwrap() []error

Variables

var (
	ErrNotFound  = errors.New("not found")
	ErrForbidden = errors.New("forbidden")
)

Common errors that may be returned by GraphQL APIs. These may be matched with errors.Is.

Functions

func WrapTransport

func WrapTransport(t http.RoundTripper) http.RoundTripper

WrapTransport wraps an HTTP transport with knowledge of GraphQL errors.

The transport will now return errors that may be cast to ErrorList or Error with errors.As.

Types

type Error

type Error struct {
	Message string `json:"message"`
	Path    []any  `json:"path"`
	Type    string `json:"type"`
}

Error is a single GraphQL error. A single response may contain multiple errors.

func (*Error) Error

func (e *Error) Error() string

func (*Error) Is

func (e *Error) Is(target error) bool

Is reports whether this error matches the target error. Use errors.Is to match against this error.

type ErrorList

type ErrorList []*Error

ErrorList is a list of GraphQL errors.

func (ErrorList) Error

func (e ErrorList) Error() string

func (ErrorList) Unwrap

func (e ErrorList) Unwrap() []error