Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace graphQL

Index

Type aliases

GraphQLResult

Type parameters

  • T

Functions

execute

  • execute<TResult, TVariables>(request: string, variables: TVariables): Promise<GraphQLResult<TResult>>
  • Executes a Sourcegraph GraphQL API query or mutation on the associated Sourcegraph instance and returns a promise for the result.

    Type parameters

    • TResult

      The GraphQL result type

    • TVariables: object

      The type of the variables object

    Parameters

    • request: string

      The GraphQL request (query or mutation)

    • variables: TVariables

      An object whose properties are GraphQL query name-value variable pairs

    Returns Promise<GraphQLResult<TResult>>

    A Promise for the result of the GraphQL request

Generated using TypeDoc