utils_src.schemadirectivevisitor

Class: SchemaDirectiveVisitor<TArgs, TContext\>#

utils/src.SchemaDirectiveVisitor

Type parameters#

NameDefault
TArgsany
TContextany

Hierarchy#

Table of contents#

Properties#

Methods#

Properties#

args#

args: TArgs

Defined in: packages/utils/src/SchemaDirectiveVisitor.ts:71


context#

context: TContext

Defined in: packages/utils/src/SchemaDirectiveVisitor.ts:79


name#

name: string

Defined in: packages/utils/src/SchemaDirectiveVisitor.ts:66


schema#

schema: GraphQLSchema

Inherited from: SchemaVisitor.schema

Defined in: packages/utils/src/SchemaVisitor.ts:23


visitedType#

visitedType: VisitableSchemaType

Defined in: packages/utils/src/SchemaDirectiveVisitor.ts:74

Methods#

visitArgumentDefinition#

visitArgumentDefinition(_argument: GraphQLArgument, _details: { field: GraphQLField<any, any, { [key: string]: any; }\> ; objectType: GraphQLInterfaceType | GraphQLObjectType<any, any\> }): void | GraphQLArgument

Parameters:#

NameType
_argumentGraphQLArgument
_details{ field: GraphQLField<any, any, { [key: string]: any; }\> ; objectType: GraphQLInterfaceType

Returns: void | GraphQLArgument

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:79


visitEnum#

visitEnum(_type: GraphQLEnumType): void | GraphQLEnumType

Parameters:#

NameType
_typeGraphQLEnumType

Returns: void | GraphQLEnumType

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:97


visitEnumValue#

visitEnumValue(_value: GraphQLEnumValue, _details: { enumType: GraphQLEnumType }): void | GraphQLEnumValue

Parameters:#

NameType
_valueGraphQLEnumValue
_details{ enumType: GraphQLEnumType }

Returns: void | GraphQLEnumValue

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:99


visitFieldDefinition#

visitFieldDefinition(_field: GraphQLField<any, any, { [key: string]: any; }\>, _details: { objectType: GraphQLInterfaceType | GraphQLObjectType<any, any\> }): void | GraphQLField<any, any, { [key: string]: any; }\>

Parameters:#

NameType
_fieldGraphQLField<any, any, { [key: string]: any; }\>
_details{ objectType: GraphQLInterfaceType

Returns: void | GraphQLField<any, any, { [key: string]: any; }\>

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:71


visitInputFieldDefinition#

visitInputFieldDefinition(_field: GraphQLInputField, _details: { objectType: GraphQLInputObjectType }): void | GraphQLInputField

Parameters:#

NameType
_fieldGraphQLInputField
_details{ objectType: GraphQLInputObjectType }

Returns: void | GraphQLInputField

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:112


visitInputObject#

visitInputObject(_object: GraphQLInputObjectType): void | GraphQLInputObjectType

Parameters:#

NameType
_objectGraphQLInputObjectType

Returns: void | GraphQLInputObjectType

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:107


visitInterface#

visitInterface(_iface: GraphQLInterfaceType): void | GraphQLInterfaceType

Parameters:#

NameType
_ifaceGraphQLInterfaceType

Returns: void | GraphQLInterfaceType

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:88


visitObject#

visitObject(_object: GraphQLObjectType<any, any\>): void | GraphQLObjectType<any, any\>

Parameters:#

NameType
_objectGraphQLObjectType<any, any\>

Returns: void | GraphQLObjectType<any, any\>

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:66


visitScalar#

visitScalar(_scalar: GraphQLScalarType): void | GraphQLScalarType

Parameters:#

NameType
_scalarGraphQLScalarType

Returns: void | GraphQLScalarType

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:61


visitSchema#

visitSchema(_schema: GraphQLSchema): void

Parameters:#

NameType
_schemaGraphQLSchema

Returns: void

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:59


visitUnion#

visitUnion(_union: GraphQLUnionType): void | GraphQLUnionType

Parameters:#

NameType
_unionGraphQLUnionType

Returns: void | GraphQLUnionType

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:94


getDirectiveDeclaration#

StaticgetDirectiveDeclaration(directiveName: string, schema: GraphQLSchema): GraphQLDirective

Parameters:#

NameType
directiveNamestring
schemaGraphQLSchema

Returns: GraphQLDirective

Defined in: packages/utils/src/SchemaDirectiveVisitor.ts:85


implementsVisitorMethod#

StaticimplementsVisitorMethod(methodName: string): boolean

Parameters:#

NameType
methodNamestring

Returns: boolean

Inherited from: SchemaVisitor

Defined in: packages/utils/src/SchemaVisitor.ts:27


visitSchemaDirectives#

StaticvisitSchemaDirectives(schema: GraphQLSchema, directiveVisitors: Record<string, typeof SchemaDirectiveVisitor\>, context?: Record<string, any\>, pathToDirectivesInExtensions?: string[]): Record<string, SchemaDirectiveVisitor<any, any\>[]\>

Parameters:#

NameTypeDefault value
schemaGraphQLSchema-
directiveVisitorsRecord<string, typeof SchemaDirectiveVisitor\>-
contextRecord<string, any\>...
pathToDirectivesInExtensionsstring[]...

Returns: Record<string, SchemaDirectiveVisitor<any, any\>[]\>

Defined in: packages/utils/src/SchemaDirectiveVisitor.ts:95