Skip to main content

group

Library supporting groupByDirective for grouping GraphQL schema entities.

See​

Option groupByDirective

getGroupName()​

function getGroupName<T>(type, groupByDirective): Maybe<string>

Gets the group name for a schema type based on the directive information.

Type Parameters​

• T

Parameters​

• type: T

a GraphQL schema named type

• groupByDirective: Maybe<GroupByDirectiveOptions>

the groupByDirective option.

Returns​

Maybe<string>

the group name matching the type, or groupByDirective.fallback if no match found.

Example​

import { buildSchema } from "graphql";
import { getGroupName } from "@graphql-markdown/utils/groups";

const schema = buildSchema(`
  directive @doc(
    category: String
  ) on OBJECT | INPUT_OBJECT | UNION | ENUM | INTERFACE | FIELD_DEFINITION | ARGUMENT_DEFINITION
  type Unicorn {
    name: String!
  }
  type Bird @doc(category: "animal") {
    name: String!
  }
  type Fish {
    name: String!
  }
  type Elf @doc(category: "fantasy") {
    name: String!
  }
  type Query {
    Fish: [Fish!]! @doc(category: "animal")
  }
`);

const groupOptions = {
  fallback: "common",
  directive: "doc",
  field: "category",
}

getGroupName(schema.getType("Bird"), groupOptions); // Expected result: "animal"

getGroupName(schema.getType("Unicorn"), groupOptions); // Expected result: "common"

Defined in​

packages/graphql/src/group.ts:72

getGroups()​

function getGroups(schemaMap, groupByDirective): Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>

Parses a GraphQL schema to build a map of entities with matching groupByDirective option.

Parameters​

• schemaMap: SchemaMap

the GraphQL schema map returned by introspection!getSchemaMap

• groupByDirective: Maybe<GroupByDirectiveOptions>

the groupByDirective option.

Returns​

Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>

a map of entities with matching group name.

Example​

import { buildSchema } from "graphql";
import { getGroups } from "@graphql-markdown/utils/groups";

const schema = buildSchema(`
  directive @doc(
    category: String
  ) on OBJECT | INPUT_OBJECT | UNION | ENUM | INTERFACE | FIELD_DEFINITION | ARGUMENT_DEFINITION
  type Unicorn {
    name: String!
  }
  type Bird @doc(category: "animal") {
    name: String!
  }
  type Fish {
    name: String!
  }
  type Elf @doc(category: "fantasy") {
    name: String!
  }
  type Query {
    Fish: [Fish!]! @doc(category: "animal")
  }
`);

const schemaMap = {
  objects: schema.getTypeMap(),
  queries: schema.getQueryType()?.getFields(),
};

const groupOptions = {
  fallback: "common",
  directive: "doc",
  field: "category",
}

const groupsMap = getGroups(schemaMap, groupOptions);

// Expected result: {
//   "objects": {
//     "Bird": "animal",
//     "Boolean": "common",
//     "Elf": "fantasy",
//     "Fish": "common",
//     "Query": "common",
//     "String": "common",
//     "Unicorn": "common",
//   },
//   "queries": {
//     "Fish": "animal",
//   },
// }

Defined in​

packages/graphql/src/group.ts:173