Documentation ¶
Overview ¶
Package graphql provides a GraphQL client implementation.
For more information, see package github.com/dpena-cb/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 ¶
- func NewJsonBlob(v []byte) *[]byte
- type Boolean
- type Client
- func (c *Client) ConstructQuery(v interface{}, variables map[string]interface{}) string
- func (c *Client) Mutate(ctx context.Context, m interface{}, variables map[string]interface{}) (*output, error)
- func (c *Client) Query(ctx context.Context, q interface{}, variables map[string]interface{}) (*output, error)
- func (c *Client) QueryMap(ctx context.Context, queryInterface interface{}, ...) (*map[string]interface{}, error)
- func (c *Client) QueryRawMessage(ctx context.Context, queryInterface interface{}, ...) (*json.RawMessage, error)
- type Float
- type ID
- type Int
- type JsonBlob
- type String
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewJsonBlob ¶
NewJsonBlob is a helper to make a new *JsonBlob.
Types ¶
type Boolean ¶
type Boolean bool
Boolean represents true or false values.
func NewBoolean ¶
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 ¶
NewClient creates a GraphQL client targeting the specified GraphQL server URL. If httpClient is nil, then http.DefaultClient is used.
func (*Client) ConstructQuery ¶
ConstructQuery will return a string of the query we're running.
func (*Client) Mutate ¶
func (c *Client) Mutate(ctx context.Context, m interface{}, variables map[string]interface{}) (*output, 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 interface{}, variables map[string]interface{}) (*output, 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.
func (*Client) QueryMap ¶
func (c *Client) QueryMap(ctx context.Context, queryInterface interface{}, variables map[string]interface{}) (*map[string]interface{}, error)
QueryMap runs a query returns a map representation of the result rather than filling in the queryInterface
func (*Client) QueryRawMessage ¶
func (c *Client) QueryRawMessage(ctx context.Context, queryInterface interface{}, variables map[string]interface{}) (*json.RawMessage, error)
QueryRawMessage runs a query returns a RawMessage (or []byte) representation of the result rather than filling in the queryInterface
type Float ¶
type Float float64
Float represents signed double-precision fractional values as specified by IEEE 754.
type ID ¶
type ID interface{}
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.
Directories ¶
Path | Synopsis |
---|---|
example
|
|
graphqldev
graphqldev is a test program currently being used for developing graphql package.
|
graphqldev is a test program currently being used for developing graphql package. |
Package ident provides functions for parsing and converting identifier names between various naming convention.
|
Package ident provides functions for parsing and converting identifier names between various naming convention. |
internal
|
|
jsonutil
Package jsonutil provides a function for decoding JSON into a GraphQL query data structure.
|
Package jsonutil provides a function for decoding JSON into a GraphQL query data structure. |