Options
All
  • Public
  • Public/Protected
  • All
Menu

Package graphql-language-service-types

graphql-language-service-types

NPM npm downloads License

API Docs

Typescript and Flow type definitions for the GraphQL Language Service and other parts of the language ecosystem.

Index

Type aliases

AllTypeInfo

AllTypeInfo: { argDef: Maybe<GraphQLArgument>; argDefs: Maybe<GraphQLArgument[]>; directiveDef: Maybe<GraphQLDirective>; enumValue: Maybe<GraphQLEnumValue>; fieldDef: Maybe<GraphQLField<any, any>>; inputType: Maybe<GraphQLType>; interfaceDef: Maybe<GraphQLInterfaceType>; objectFieldDefs: Maybe<GraphQLInputFieldMap>; objectTypeDef: Maybe<GraphQLObjectType>; parentType: Maybe<GraphQLType>; type: Maybe<GraphQLType> }

Type declaration

  • argDef: Maybe<GraphQLArgument>
  • argDefs: Maybe<GraphQLArgument[]>
  • directiveDef: Maybe<GraphQLDirective>
  • enumValue: Maybe<GraphQLEnumValue>
  • fieldDef: Maybe<GraphQLField<any, any>>
  • inputType: Maybe<GraphQLType>
  • interfaceDef: Maybe<GraphQLInterfaceType>
  • objectFieldDefs: Maybe<GraphQLInputFieldMap>
  • objectTypeDef: Maybe<GraphQLObjectType>
  • parentType: Maybe<GraphQLType>
  • type: Maybe<GraphQLType>

CachedContent

CachedContent: { query: string; range: IRange | null }

Type declaration

  • query: string
  • range: IRange | null

CompletionItem

CompletionItem: CompletionItemType & { deprecationReason?: string | null; documentation?: string | null; isDeprecated?: boolean; type?: GraphQLType }

CompletionItemBase

CompletionItemBase: { isDeprecated?: boolean; label: string }

Type declaration

  • Optional isDeprecated?: boolean
  • label: string

Definition

Definition: { id?: string; language?: string; name?: string; path: Uri; position: IPosition; projectRoot?: Uri; range?: IRange }

Type declaration

  • Optional id?: string
  • Optional language?: string
  • Optional name?: string
  • path: Uri
  • position: IPosition
  • Optional projectRoot?: Uri
  • Optional range?: IRange

Diagnostic

Diagnostic: DiagnosticType

FileChangeType

FileChangeType: FileChangeTypeKind[FileChangeTypeKeys]

FileChangeTypeKeys

FileChangeTypeKeys: keyof FileChangeTypeKind

FileChangeTypeKind

FileChangeTypeKind: { Changed: 2; Created: 1; Deleted: 3 }

Type declaration

  • Changed: 2
  • Created: 1
  • Deleted: 3

FragmentInfo

FragmentInfo: { content: string; definition: FragmentDefinitionNode; filePath?: Uri }

Type declaration

  • content: string
  • definition: FragmentDefinitionNode
  • Optional filePath?: Uri

GraphQLFileInfo

GraphQLFileInfo: { asts: DocumentNode[]; content: string; filePath: Uri; mtime: number; queries: CachedContent[]; size: number }

Type declaration

  • asts: DocumentNode[]
  • content: string
  • filePath: Uri
  • mtime: number
  • queries: CachedContent[]
  • size: number

GraphQLFileMetadata

GraphQLFileMetadata: { filePath: Uri; mtime: number; size: number }

Type declaration

  • filePath: Uri
  • mtime: number
  • size: number

Maybe

Maybe<T>: T | null | undefined

Type parameters

  • T

NamedTypeInfo

NamedTypeInfo: { content: string; definition: NamedTypeNode; filePath?: Uri }

Type declaration

  • content: string
  • definition: NamedTypeNode
  • Optional filePath?: Uri

ObjectTypeInfo

ObjectTypeInfo: { content: string; definition: TypeDefinitionNode; filePath?: Uri }

Type declaration

  • content: string
  • definition: TypeDefinitionNode
  • Optional filePath?: Uri

Outline

Outline: { outlineTrees: OutlineTree[] }

Type declaration

OutlineTree

OutlineTree: { children: OutlineTree[]; endPosition?: IPosition; kind: string; plainText?: string; representativeName?: string; startPosition: IPosition; tokenizedText?: TokenizedText }

Type declaration

TextToken

TextToken: { kind: TokenKind; value: string | NameNode }

Type declaration

TokenKind

TokenKind: "keyword" | "class-name" | "constructor" | "method" | "param" | "string" | "whitespace" | "plain" | "type"

TokenizedText

TokenizedText: TextToken[]

Uri

Uri: string

Object literals

Const FileChangeTypeKind

FileChangeTypeKind: object

Changed

Changed: number = 2

Created

Created: number = 1

Deleted

Deleted: number = 3

Generated using TypeDoc