package graphql

import "github.com/shurcooL/graphql"

Package graphql provides a GraphQL client implementation.

For more information, see package github.com/shurcooL/githubv4, which is a specialized version targeting GitHub GraphQL API v4. That package is driving the feature development.

For now, see README for more details.

Index ¶

• type Boolean
• func NewBoolean(v Boolean) *Boolean
• type Client
• func NewClient(url string, httpClient *http.Client) *Client
• func (c *Client) Mutate(ctx context.Context, m any, variables map[string]any) error
• func (c *Client) Query(ctx context.Context, q any, variables map[string]any) error
• type Float
• func NewFloat(v Float) *Float
• type ID
• func NewID(v ID) *ID
• type Int
• func NewInt(v Int) *Int
• type String
• func NewString(v String) *String

Types ¶

type Boolean ¶

type Boolean bool

Boolean represents true or false values.

func NewBoolean ¶

func NewBoolean(v Boolean) *Boolean

NewBoolean is a helper to make a new *Boolean.

type Client ¶

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

Client is a GraphQL client.

func NewClient ¶

func NewClient(url string, httpClient *http.Client) *Client

NewClient creates a GraphQL client targeting the specified GraphQL server URL. If httpClient is nil, then http.DefaultClient is used.

func (*Client) Mutate ¶

func (c *Client) Mutate(ctx context.Context, m any, variables map[string]any) error

Mutate executes a single GraphQL mutation request, with a mutation derived from m, populating the response into it. m should be a pointer to struct that corresponds to the GraphQL schema.

func (*Client) Query ¶

func (c *Client) Query(ctx context.Context, q any, variables map[string]any) error

Query executes a single GraphQL query request, with a query derived from q, populating the response into it. q should be a pointer to struct that corresponds to the GraphQL schema.

type Float ¶

type Float float64

Float represents signed double-precision fractional values as specified by IEEE 754.

func NewFloat ¶

func NewFloat(v Float) *Float

NewFloat is a helper to make a new *Float.

type ID ¶

type ID any

ID represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

func NewID ¶

func NewID(v ID) *ID

NewID is a helper to make a new *ID.

type Int ¶

type Int int32

Int represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

func NewInt ¶

func NewInt(v Int) *Int

NewInt is a helper to make a new *Int.

type String ¶

type String string

String represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

func NewString ¶

func NewString(v String) *String

NewString is a helper to make a new *String.

Source Files ¶

doc.go graphql.go query.go scalar.go

Directories ¶