createEdgeType() — supabase Function Reference

Architecture documentation for the createEdgeType() function in connections.ts from the supabase codebase.

Function typescript DocumentationSystem ReferenceGen calls 1 called by 1

Entity Profile

DocumentationSystem→ ReferenceGen→ createEdgeType() — supabase Function Reference

Dependency Diagram

graph TD
  a2c6c6c2_a03f_fbd8_01d2_1110ce962f66["createEdgeType()"]
  142dc086_6deb_1447_62a9_58b1521311df["createCollectionType()"]
  142dc086_6deb_1447_62a9_58b1521311df -->|calls| a2c6c6c2_a03f_fbd8_01d2_1110ce962f66
  1b2b73ba_8c31_fa3f_0d0c_c864516123ad["extractNodeTypeName()"]
  a2c6c6c2_a03f_fbd8_01d2_1110ce962f66 -->|calls| 1b2b73ba_8c31_fa3f_0d0c_c864516123ad
  style a2c6c6c2_a03f_fbd8_01d2_1110ce962f66 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

apps/docs/resources/utils/connections.ts lines 48–83

function createEdgeType(
  nodeType: GraphQLOutputType,
  {
    name,
    skipCursor = false,
  }: {
    /**
     * The name of the created Edge node. If not provided, defaults to
     * NameOfInnerNodeEdge.
     */
    name?: string
    /**
     * Whether to skip the cursor field.
     */
    skipCursor?: boolean
  } = {}
): GraphQLObjectType {
  const edgeName = name || `${extractNodeTypeName(nodeType)}Edge`

  return new GraphQLObjectType({
    name: edgeName,
    description: `An edge in a collection of ${extractNodeTypeName(nodeType)}s`,
    fields: {
      node: {
        type: new GraphQLNonNull(nodeType),
        description: `The ${extractNodeTypeName(nodeType)} at the end of the edge`,
      },
      ...(!skipCursor && {
        cursor: {
          type: new GraphQLNonNull(GraphQLString),
          description: 'A cursor for use in pagination',
        },
      }),
    },
  })
}