AltairWindowOptions

Extended by

• AltairConfigOptions

Properties

endpointURL?

optional endpointURL: string

URL to set as the server endpoint

---

initialHeaders?

optional initialHeaders: IDictionary

Initial headers object to be added

Example

{
   *  'X-GraphQL-Token': 'asd7-237s-2bdk-nsdk4'
   * }

---

initialHttpMethod?

optional initialHttpMethod: "POST" | "GET" | "PUT" | "DELETE"

HTTP method to use for making requests

---

initialName?

optional initialName: string

Initial name of the window

---

initialPostRequestScript?

optional initialPostRequestScript: string

Initial post-request script to be added

---

initialPreRequestScript?

optional initialPreRequestScript: string

Initial pre-request script to be added

---

initialQuery?

optional initialQuery: string

Initial query to be added

---

initialRequestHandlerAdditionalParams?

optional initialRequestHandlerAdditionalParams: Record<string, unknown>

Additional params to be passed to the request handler

---

initialRequestHandlerId?

optional initialRequestHandlerId: RequestHandlerIds

Initial request handler id

Default

"http"

---

initialSubscriptionRequestHandlerId?

optional initialSubscriptionRequestHandlerId: RequestHandlerIds

Initial subscriptions provider

Default

"websocket"

---

initialSubscriptionsPayload?

optional initialSubscriptionsPayload: IDictionary

Initial subscriptions connection params

---

initialVariables?

optional initialVariables: string

Initial variables to be added

---

subscriptionsEndpoint?

optional subscriptionsEndpoint: string

URL to set as the subscription endpoint. This can be relative or absolute.

---

subscriptionsProtocol?

optional subscriptionsProtocol: string

URL protocol for the subscription endpoint. This is used if the specified subscriptions endpoint is relative. e.g. wss