Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GraphiQLHandlerOptions

Embedded GraphiQL user interface options.

Hierarchy

  • GraphiQLHandlerOptions

Index

Constructors

Methods

Constructors

constructor

Methods

getGraphQLUri

  • getGraphQLUri(): string

  • Set the GraphQL HTTP endpoint URI. Defaults to GraphiQLHandlerOptions.

    Returns string

getGraphQLWSUri

  • getGraphQLWSUri(): string

  • Returns string

getHeaders

  • getHeaders(): {}

  • A fixed set of HTTP headers to add to GraphiQL requests. Defaults to null.

    Returns {}

    • [key: string]: string

getQuery

  • getQuery(): string

  • Initial value of the query area in the GraphiQL user interface. Defaults to null.

    Returns string

getVariables

  • getVariables(): {}

  • Initial value of the variables area in the GraphiQL user interface. Defaults to null.

    Returns {}

    • [key: string]: any

getWsConnectionParams

  • getWsConnectionParams(): {}

  • Initial GraphQLWS connection params. Defaults to null.

    Returns {}

    • [key: string]: any

isEnabled

  • isEnabled(): boolean

  • Whether the GraphiQL development tool should be enabled. Defaults to false.

    Returns boolean

isGraphQLWSEnabled

  • isGraphQLWSEnabled(): boolean

  • Whether the GraphQLWS transport should be enabled. Defaults to true.

    Returns boolean

isHttpEnabled

  • isHttpEnabled(): boolean

  • Whether the HTTP transport should be enabled. Defaults to true.

    Returns boolean

setEnabled

  • Whether the GraphiQL development tool should be enabled. Defaults to false.

    Parameters

    • enabled: boolean

    Returns GraphiQLHandlerOptions

setGraphQLUri

setGraphQLWSEnabled

  • Whether the GraphQLWS transport should be enabled. Defaults to true.

    Parameters

    • graphQLWSEnabled: boolean

    Returns GraphiQLHandlerOptions

setGraphWSQLUri

setHeaders

  • A fixed set of HTTP headers to add to GraphiQL requests. Defaults to null.

    Parameters

    • headers: {}
      • [key: string]: string

    Returns GraphiQLHandlerOptions

setHttpEnabled

  • Whether the HTTP transport should be enabled. Defaults to true.

    Parameters

    • httpEnabled: boolean

    Returns GraphiQLHandlerOptions

setQuery

  • Initial value of the query area in the GraphiQL user interface. Defaults to null.

    Parameters

    • query: string

    Returns GraphiQLHandlerOptions

setVariables

  • Initial value of the variables area in the GraphiQL user interface. Defaults to null.

    Parameters

    • variables: {}
      • [key: string]: any

    Returns GraphiQLHandlerOptions

setWsConnectionParams

  • Initial GraphQLWS connection params. Defaults to null.

    Parameters

    • wsConnectionParams: {}
      • [key: string]: any

    Returns GraphiQLHandlerOptions

toJson

  • toJson(): {}

  • Returns {}

    • [key: string]: any

Generated using TypeDoc