Class IndexerAPISchema`Abstract`

Combines the indexer's domain class with the fetcher's API.

Hierarchy

GraphQLSchema
- IndexerAPISchema

Index

Constructors

constructor

new IndexerAPISchema(domain: IndexerMainDomain, config: APISchemaConfig): IndexerAPISchema
Parameters
- domain: IndexerMainDomain
- config: APISchemaConfig
Returns IndexerAPISchema
Overrides GraphQLSchema.constructor
- Defined in packages/framework/src/utils/api/indexer/schema.ts:24

Properties

astNode

astNode: Maybe<SchemaDefinitionNode>

description

description: Maybe<string>

`Protected` domain

domain: IndexerMainDomain

extensionASTNodes

extensionASTNodes: Maybe<readonly SchemaExtensionNode[]>

extensions

extensions: Maybe<Readonly<GraphQLSchemaExtensions>>

Methods

getDirective

getDirective(name: string): Maybe<GraphQLDirective>
Parameters
- name: string
Returns Maybe<GraphQLDirective>
Inherited from GraphQLSchema.getDirective
- Defined in node_modules/graphql/type/schema.d.ts:94

getDirectives

getDirectives(): readonly GraphQLDirective[]
Returns readonly GraphQLDirective[]
Inherited from GraphQLSchema.getDirectives
- Defined in node_modules/graphql/type/schema.d.ts:93

getImplementations

getImplementations(interfaceType: GraphQLInterfaceType): InterfaceImplementations
Parameters
- interfaceType: GraphQLInterfaceType
Returns InterfaceImplementations
Inherited from GraphQLSchema.getImplementations
- Defined in node_modules/graphql/type/schema.d.ts:78

getMutationType

getMutationType(): Maybe<GraphQLObjectType<any, any>>
Returns Maybe<GraphQLObjectType<any, any>>
Inherited from GraphQLSchema.getMutationType
- Defined in node_modules/graphql/type/schema.d.ts:69

getPossibleTypes

getPossibleTypes(abstractType: GraphQLAbstractType): readonly GraphQLObjectType<any, any>[]
Parameters
- abstractType: GraphQLAbstractType
Returns readonly GraphQLObjectType<any, any>[]
Inherited from GraphQLSchema.getPossibleTypes
- Defined in node_modules/graphql/type/schema.d.ts:74

getQueryType

getQueryType(): Maybe<GraphQLObjectType<any, any>>
Returns Maybe<GraphQLObjectType<any, any>>
Inherited from GraphQLSchema.getQueryType
- Defined in node_modules/graphql/type/schema.d.ts:68

getSubscriptionType

getSubscriptionType(): Maybe<GraphQLObjectType<any, any>>
Returns Maybe<GraphQLObjectType<any, any>>
Inherited from GraphQLSchema.getSubscriptionType
- Defined in node_modules/graphql/type/schema.d.ts:70

getType

getType(name: string): Maybe<GraphQLNamedType>
Parameters
- name: string
Returns Maybe<GraphQLNamedType>
Inherited from GraphQLSchema.getType
- Defined in node_modules/graphql/type/schema.d.ts:72

getTypeMap

getTypeMap(): TypeMap
Returns TypeMap
Inherited from GraphQLSchema.getTypeMap
- Defined in node_modules/graphql/type/schema.d.ts:71

isPossibleType

isPossibleType(abstractType: GraphQLAbstractType, possibleType: GraphQLObjectType<any, any>): boolean
Parameters
- abstractType: GraphQLAbstractType
- possibleType: GraphQLObjectType<any, any>
Returns boolean
Inherited from GraphQLSchema.isPossibleType
- Defined in node_modules/graphql/type/schema.d.ts:83

isSubType

isSubType(abstractType: GraphQLAbstractType, maybeSubType: GraphQLNamedType): boolean
Parameters
- abstractType: GraphQLAbstractType
- maybeSubType: GraphQLNamedType
Returns boolean
Inherited from GraphQLSchema.isSubType
- Defined in node_modules/graphql/type/schema.d.ts:88

toConfig

toConfig(): GraphQLSchemaConfig & {
    assumeValid: boolean;
    directives: GraphQLDirective[];
    extensionASTNodes: readonly SchemaExtensionNode[];
    extensions: Maybe<Readonly<GraphQLSchemaExtensions>>;
    types: GraphQLNamedType[];
}
Returns GraphQLSchemaConfig & {
    assumeValid: boolean;
    directives: GraphQLDirective[];
    extensionASTNodes: readonly SchemaExtensionNode[];
    extensions: Maybe<Readonly<GraphQLSchemaExtensions>>;
    types: GraphQLNamedType[];
}
Inherited from GraphQLSchema.toConfig
- Defined in node_modules/graphql/type/schema.d.ts:96

Class IndexerAPISchemaAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

domain: IndexerMainDomain

config: APISchemaConfig

Returns IndexerAPISchema

Properties

astNode

description

Protected domain

extensionASTNodes

extensions

Methods

getDirective

Parameters

name: string

Returns Maybe<GraphQLDirective>

getDirectives

Returns readonly GraphQLDirective[]

getImplementations

Parameters

interfaceType: GraphQLInterfaceType

Returns InterfaceImplementations

getMutationType

Returns Maybe<GraphQLObjectType<any, any>>

getPossibleTypes

Parameters

abstractType: GraphQLAbstractType

Returns readonly GraphQLObjectType<any, any>[]

getQueryType

Returns Maybe<GraphQLObjectType<any, any>>

getSubscriptionType

Returns Maybe<GraphQLObjectType<any, any>>

getType

Parameters

name: string

Returns Maybe<GraphQLNamedType>

getTypeMap

Returns TypeMap

isPossibleType

Parameters

abstractType: GraphQLAbstractType

possibleType: GraphQLObjectType<any, any>

Returns boolean

isSubType

Parameters

abstractType: GraphQLAbstractType

maybeSubType: GraphQLNamedType

Returns boolean

toConfig

Returns GraphQLSchemaConfig & { assumeValid: boolean; directives: GraphQLDirective[]; extensionASTNodes: readonly SchemaExtensionNode[]; extensions: Maybe<Readonly<GraphQLSchemaExtensions>>; types: GraphQLNamedType[]; }

Settings

Member Visibility

Theme

Class IndexerAPISchema`Abstract`

`Protected` domain

Returns GraphQLSchemaConfig & {
assumeValid: boolean;
directives: GraphQLDirective[];
extensionASTNodes: readonly SchemaExtensionNode[];
extensions: Maybe<Readonly<GraphQLSchemaExtensions>>;
types: GraphQLNamedType[];
}