Merge pull request #48 from taion/connection-name

Default connection name from node type name

Author: dschafer

README.md

@@ -52,7 +52,7 @@ when they return a connection type that only supports forward pagination.
  - `backwardConnectionArgs` returns the arguments that fields should provide
 when they return a connection type that only supports backward pagination.
  - `connectionDefinitions` returns a `connectionType` and its associated
-`edgeType`, given a name and a node type.
+`edgeType`, given a node type.
  - `connectionFromArray` is a helper method that takes an array and the
 arguments from `connectionArgs`, does pagination and filtering, and returns
 an object in the shape expected by a `connectionType`'s `resolve` function.
@@ -66,7 +66,7 @@ An example usage of these methods from the [test schema](src/__tests__/starWarsS
 
 ```js
 var {connectionType: ShipConnection} =
-  connectionDefinitions({name: 'Ship', nodeType: shipType});
+  connectionDefinitions({nodeType: shipType});
 var factionType = new GraphQLObjectType({
   name: 'Faction',
   fields: () => ({
@@ -83,10 +83,10 @@ var factionType = new GraphQLObjectType({
 ```
 
 This shows adding a `ships` field to the `Faction` object that is a connection.
-It uses `connectionDefinitions({name: 'Ship', nodeType: shipType})` to create
-the connection type, adds `connectionArgs` as arguments on this function, and
-then implements the resolve function by passing the array of ships and the
-arguments to `connectionFromArray`.
+It uses `connectionDefinitions({nodeType: shipType})` to create the connection
+type, adds `connectionArgs` as arguments on this function, and then implements
+the resolve function by passing the array of ships and the arguments to
+`connectionFromArray`.
 
 ### Object Identification
 

src/__tests__/starWarsSchema.js

@@ -178,7 +178,7 @@ var shipType = new GraphQLObjectType({
  *   }
  */
 var {connectionType: shipConnection} =
-  connectionDefinitions({name: 'Ship', nodeType: shipType});
+  connectionDefinitions({nodeType: shipType});
 
 /**
  * We define our faction type, which implements the node interface.

src/connection/__tests__/connection.js

@@ -49,12 +49,12 @@ var userType = new GraphQLObjectType({
       resolve: (user, args) => connectionFromArray(user.friends, args),
     },
     friendsForward: {
-      type: friendConnection,
+      type: userConnection,
       args: forwardConnectionArgs,
       resolve: (user, args) => connectionFromArray(user.friends, args),
     },
     friendsBackward: {
-      type: friendConnection,
+      type: userConnection,
       args: backwardConnectionArgs,
       resolve: (user, args) => connectionFromArray(user.friends, args),
     },
@@ -79,6 +79,11 @@ var {connectionType: friendConnection} = connectionDefinitions({
   }),
 });
 
+var {connectionType: userConnection} = connectionDefinitions({
+  nodeType: userType,
+  resolveNode: edge => allUsers[edge.node],
+});
+
 var queryType = new GraphQLObjectType({
   name: 'Query',
   fields: () => ({

src/connection/connection.js

@@ -58,7 +58,7 @@ export var connectionArgs: GraphQLFieldConfigArgumentMap = {
 };
 
 type ConnectionConfig = {
-  name: string,
+  name?: ?string,
   nodeType: GraphQLObjectType,
   resolveNode?: ?Function,
   resolveCursor?: ?Function,
@@ -82,7 +82,8 @@ function resolveMaybeThunk<T>(thingOrThunk: T | () => T): T {
 export function connectionDefinitions(
   config: ConnectionConfig
 ): GraphQLConnectionDefinitions {
-  var {name, nodeType} = config;
+  var {nodeType} = config;
+  var name = config.name != null ? config.name : nodeType.name;
   var edgeFields = config.edgeFields || {};
   var connectionFields = config.connectionFields || {};
   var resolveNode = config.resolveNode;