relation
Library supporting relatedTypeSection
for displaying relations between GraphQL schema entities.
Seeβ
getRelationOfFieldβ
const getRelationOfField: IGetRelation<RelationOfField>;
Defined in: packages/graphql/src/relation.ts:167
Returns a map of fields and arguments where the GraphQL schema type matches the type.
Seeβ
mapRelationOf
Type Paramβ
the type of the GraphQL schema type.
Type Paramβ
the return type of map of relations (see IGetRelation).
Paramβ
the GraphQL schema type being processed.
Paramβ
a GraphQL schema map (see introspection!getSchemaMap).
Returnsβ
a record map of fields and arguments relations.
getRelationOfImplementationβ
const getRelationOfImplementation: IGetRelation<RelationOfImplementation>;
Defined in: packages/graphql/src/relation.ts:353
Returns a map of types (unions or interfaces) where the GraphQL schema type is implemented.
Seeβ
mapRelationOf
Type Paramβ
the type of the GraphQL schema type.
Type Paramβ
the return type of map of relations (see IGetRelation).
Paramβ
the GraphQL schema type being processed.
Paramβ
a GraphQL schema map (see introspection!getSchemaMap).
Returnsβ
a record map of unions or interfaces relations.
getRelationOfInterfaceβ
const getRelationOfInterface: IGetRelation<RelationOfInterface>;
Defined in: packages/graphql/src/relation.ts:296
Returns a map of interfaces where the GraphQL schema type is extended.
Seeβ
mapRelationOf
Type Paramβ
the type of the GraphQL schema type.
Type Paramβ
the return type of map of relations (see IGetRelation).
Paramβ
the GraphQL schema type being processed.
Paramβ
a GraphQL schema map (see introspection!getSchemaMap).
Returnsβ
a record map of interfaces relations.
getRelationOfReturnβ
const getRelationOfReturn: IGetRelation<GraphQLOperationType>;
Defined in: packages/graphql/src/relation.ts:106
Returns a map of operations (queries, mutations, subscriptions) where the GraphQL schema type is the return type.
Seeβ
mapRelationOf
Type Paramβ
the type of the GraphQL schema type.
Type Paramβ
the return type of map of relations (see IGetRelation).
Paramβ
the GraphQL schema type being processed.
Paramβ
a GraphQL schema map (see introspection!getSchemaMap).
Returnsβ
a record map of operations relations.
getRelationOfUnionβ
const getRelationOfUnion: IGetRelation<GraphQLUnionType>;
Defined in: packages/graphql/src/relation.ts:240
Returns a map of unions where the GraphQL schema type is part of it.
Seeβ
mapRelationOf
Type Paramβ
the type of the GraphQL schema type.
Type Paramβ
the return type of map of relations (see IGetRelation).
Paramβ
the GraphQL schema type being processed.
Paramβ
a GraphQL schema map (see introspection!getSchemaMap).
Returnsβ
a record map of unions relations.