Class GraphQLIntrospector

Index

Constructors

Methods

buildClientSchemaFromIntrospection getIntrospectionQueryBody introspect validateIntrospectionQueryResult

Constructors

constructor

new GraphQLIntrospector(
options?: GraphQLIntrospectorOptions,
): GraphQLIntrospector
Parameters
- Optionaloptions: GraphQLIntrospectorOptions
Returns GraphQLIntrospector
- Defined in src/introspect/GraphQLIntrospector.ts:35

Methods

buildClientSchemaFromIntrospection

buildClientSchemaFromIntrospection(
    url: string,
    headers?: Record<string, string>,
    introspectionOptions?: IntrospectionOptions,
): Promise<GraphQLSchema>
Parameters
- url: string
- Optionalheaders: Record<string, string>
- OptionalintrospectionOptions: IntrospectionOptions
Returns Promise<GraphQLSchema>
- Defined in src/introspect/GraphQLIntrospector.ts:40

getIntrospectionQueryBody

getIntrospectionQueryBody(
introspectionOptions?: IntrospectionOptions,
): { query: string }
Parameters
- OptionalintrospectionOptions: IntrospectionOptions
Returns { query: string }
- Defined in src/introspect/GraphQLIntrospector.ts:106

introspect

introspect(
    url: string,
    headers?: Record<string, string>,
    introspectionOptions?: IntrospectionOptions,
): Promise<IntrospectionQuery>
Parameters
- url: string
- Optionalheaders: Record<string, string>
- OptionalintrospectionOptions: IntrospectionOptions
Returns Promise<IntrospectionQuery>
- Defined in src/introspect/GraphQLIntrospector.ts:50

validateIntrospectionQueryResult

validateIntrospectionQueryResult(result: unknown): IntrospectionQuery
Parameters
- result: unknown
Returns IntrospectionQuery
- Defined in src/introspect/GraphQLIntrospector.ts:86