Skip to main content

relation

Library supporting relatedTypeSection for displaying relations between GraphQL schema entities.

See

Option relatedTypeSection

getRelationOfField

const getRelationOfField: IGetRelation<RelationOfField>;

Defined in: packages/graphql/src/relation.ts:164

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 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 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 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 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 getSchemaMap).

Returns

a record map of unions relations.