Categorygithub.com/graphql-go/relay
modulepackage
0.0.0-20171208134043-54350098cfe5
Repository: https://github.com/graphql-go/relay.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
9
Dependents
11
Files
544 SLOC

# README

graphql-relay-go Build Status GoDoc Coverage Status Join the chat at https://gitter.im/graphql-go/graphql

A Go/Golang library to help construct a graphql-go server supporting react-relay.

See a live demo here: http://bit.ly/try-graphql-go

Source code for demo can be found at https://github.com/graphql-go/playground

Notes:

This is based on alpha version of graphql-go and graphql-relay-go. Be sure to watch both repositories for latest changes.

Tutorial

Learn Golang + GraphQL + Relay Part 2: Your first Relay application

Test

$ go get github.com/graphql-go/relay
$ go build && go test ./...

TODO:

  • Starwars example
  • HTTP handler to easily create a Relay-compliant GraphQL server (Moved to: graphql-go-handler)
  • In-code documentation (godocs)
  • Usage guide / user documentation
  • Tutorial
  • End-to-end example (graphql-relay-go + react-relay)

# Packages

No description provided by the author

# Functions

No description provided by the author
A simple function that accepts an array and connection arguments, and returns a connection object for use in GraphQL.
Given a slice (subset) of an array, returns a connection object for use in GraphQL.
Return the cursor associated with an object in an array.
Re-derives the offset from the cursor string.
Takes the "global ID" created by toGlobalID, and returns the type name and ID used to create it.
No description provided by the author
Creates the configuration for an id field on a node, using `toGlobalId` to construct the ID from the provided typename.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Given a function to map from an ID to an underlying object, and a function to map from an underlying object to the concrete GraphQLObjectType it corresponds to, constructs a `Node` interface that objects can implement, and a field config for a `node` root field.
Creates the cursor string from an offset.
No description provided by the author
Takes a type name and an ID specific to that type name, and returns a "global ID" that is unique among all types.

# Constants

No description provided by the author

# Variables

Returns a GraphQLFieldConfigArgumentMap appropriate to include on a field whose return type is a connection type.

# Structs

No description provided by the author
No description provided by the author
Use NewConnectionArguments() to properly initialize default values.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A description of a mutation consumable by mutationWithClientMutationId to create a GraphQLField for that mutation.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author