Altair GraphQL Client

Appearance

altairWindowOptionsSchema ​

const altairWindowOptionsSchema: ZodObject<object, $strip>

Type declaration ​

endpointURL ​

endpointURL: ZodOptional<ZodString>

URL to set as the server endpoint

initialAuthorization ​

initialAuthorization: ZodOptional<ZodDiscriminatedUnion<[ZodObject<object, $strip>, ZodObject<object, $strip>, ZodObject<object, $strip>, ZodObject<object, $strip>, ZodObject<object, $strip>], "type">>

Initial authorization type and data

initialHeaders ​

initialHeaders: ZodOptional<ZodRecord<ZodString, ZodUnknown>>

Initial headers object to be added

Example ​

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

initialHttpMethod ​

initialHttpMethod: ZodOptional<ZodEnum<object>>

Initial HTTP method to use for making requests

initialName ​

initialName: ZodOptional<ZodString>

Initial name of the window

initialPostRequestScript ​

initialPostRequestScript: ZodOptional<ZodString>

Initial post-request script to be added

initialPreRequestScript ​

initialPreRequestScript: ZodOptional<ZodString>

Initial pre-request script to be added

initialQuery ​

initialQuery: ZodOptional<ZodString>

Initial query to be added

initialRequestHandlerAdditionalParams ​

initialRequestHandlerAdditionalParams: ZodOptional<ZodRecord<ZodString, ZodUnknown>>

Additional params to be passed to the request handler

initialRequestHandlerId ​

initialRequestHandlerId: ZodOptional<ZodEnum<object>>

Initial request handler id

Default ​

ts
"http"

initialSubscriptionRequestHandlerId ​

initialSubscriptionRequestHandlerId: ZodOptional<ZodEnum<object>>

Initial subscriptions provider

Default ​

ts
"websocket"

initialSubscriptionsPayload ​

initialSubscriptionsPayload: ZodNullable<ZodOptional<ZodRecord<ZodString, ZodUnknown>>>

Initial subscriptions connection params

initialVariables ​

initialVariables: ZodOptional<ZodString>

Initial variables to be added

subscriptionsEndpoint ​

subscriptionsEndpoint: ZodOptional<ZodString>

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

subscriptionsProtocol ​

subscriptionsProtocol: ZodOptional<ZodString>

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