graphql-tools-monorepo / utils/src / ExecutionResult

Interface: ExecutionResult<TData, TExtensions>

utils/src.ExecutionResult

The result of GraphQL execution.

• errors is included when any errors occurred as a non-empty array.
• data is the result of a successful execution of the query.
• hasNext is true if a future payload is expected.
• extensions is reserved for adding non-standard properties.

Type parameters

Table of contents

Properties

• completed
• data
• errors
• extensions
• hasNext
• id
• incremental
• items
• label
• path
• pending
• subPath

Properties

completed

• Optional completed: readonly { errors?: readonly GraphQLError[] ; id: string }[]

Defined in

packages/utils/src/Interfaces.ts:72

data

• Optional data: null | TData

Defined in

packages/utils/src/Interfaces.ts:62

errors

• Optional errors: readonly GraphQLError[]

Defined in

packages/utils/src/Interfaces.ts:63

extensions

• Optional extensions: TExtensions

Defined in

packages/utils/src/Interfaces.ts:65

hasNext

• Optional hasNext: boolean

Defined in

packages/utils/src/Interfaces.ts:64

id

• Optional id: string

Defined in

packages/utils/src/Interfaces.ts:69

incremental

• Optional incremental: readonly ExecutionResult<TData, TExtensions>[]

Defined in

packages/utils/src/Interfaces.ts:61

items

• Optional items: null | TData

Defined in

packages/utils/src/Interfaces.ts:68

label

• Optional label: string

Defined in

packages/utils/src/Interfaces.ts:66

path

• Optional path: readonly (string | number)[]

Defined in

packages/utils/src/Interfaces.ts:67

pending

• Optional pending: readonly { id: string ; path: readonly (string | number)[] }[]

Defined in

packages/utils/src/Interfaces.ts:71

subPath

• Optional subPath: readonly (string | number)[]

Defined in

packages/utils/src/Interfaces.ts:70