Altair GraphQL Client

Appearance

AltairConfigOptions ​

Extends ​

Properties ​

cspNonce? ​

optional cspNonce: string

CSP nonce value to be used in Altair

disableAccount? ​

optional disableAccount: boolean

Disable the account and remote syncing functionality

endpointURL? ​

optional endpointURL: string

URL to set as the server endpoint

Inherited from ​

AltairWindowOptions.endpointURL

initialAuthorization? ​

optional initialAuthorization: AuthorizationProviderInput

Initial authorization type and data

Inherited from ​

AltairWindowOptions.initialAuthorization

initialEnvironments? ​

optional initialEnvironments: IInitialEnvironments

Initial Environments to be added

Example ​

ts
{
   *   activeSubEnvironment: 'sub-1'
   *   base: {
   *     title: 'Environment',
   *     variables: {}
   *   },
   *   subEnvironments: [
   *     {
   *       title: 'sub-1',
   *       variables: {}
   *     }
   *   ]
   * }

initialHeaders? ​

optional initialHeaders: IDictionary

Initial headers object to be added

Example ​

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

Inherited from ​

AltairWindowOptions.initialHeaders

initialHttpMethod? ​

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

HTTP method to use for making requests

Inherited from ​

AltairWindowOptions.initialHttpMethod

initialName? ​

optional initialName: string

Initial name of the window

Inherited from ​

AltairWindowOptions.initialName

initialPostRequestScript? ​

optional initialPostRequestScript: string

Initial post-request script to be added

Inherited from ​

AltairWindowOptions.initialPostRequestScript

initialPreRequestScript? ​

optional initialPreRequestScript: string

Initial pre-request script to be added

Inherited from ​

AltairWindowOptions.initialPreRequestScript

initialQuery? ​

optional initialQuery: string

Initial query to be added

Inherited from ​

AltairWindowOptions.initialQuery

initialRequestHandlerAdditionalParams? ​

optional initialRequestHandlerAdditionalParams: Record<string, unknown>

Additional params to be passed to the request handler

Inherited from ​

AltairWindowOptions.initialRequestHandlerAdditionalParams

initialRequestHandlerId? ​

optional initialRequestHandlerId: RequestHandlerIds

Initial request handler id

Default ​

ts
"http"

Inherited from ​

AltairWindowOptions.initialRequestHandlerId

initialSettings? ​

optional initialSettings: Partial<SettingsState>

Initial app settings to use

initialSubscriptionRequestHandlerId? ​

optional initialSubscriptionRequestHandlerId: RequestHandlerIds

Initial subscriptions provider

Default ​

ts
"websocket"

Inherited from ​

AltairWindowOptions.initialSubscriptionRequestHandlerId

initialSubscriptionsPayload? ​

optional initialSubscriptionsPayload: IDictionary

Initial subscriptions connection params

Inherited from ​

AltairWindowOptions.initialSubscriptionsPayload

initialVariables? ​

optional initialVariables: string

Initial variables to be added

Inherited from ​

AltairWindowOptions.initialVariables

initialWindows? ​

optional initialWindows: AltairWindowOptions[]

List of options for windows to be loaded

instanceStorageNamespace? ​

optional instanceStorageNamespace: string

Namespace for storing the data for the altair instance. Use this when you have multiple altair instances running on the same domain.

Example ​

ts
instanceStorageNamespace: 'altair_dev_'

persistedSettings? ​

optional persistedSettings: Partial<SettingsState>

Persisted settings for the app. The settings will be merged with the app settings.

preserveState? ​

optional preserveState: boolean

Indicates if the state should be preserved for subsequent app loads

Default ​

ts
true

subscriptionsEndpoint? ​

optional subscriptionsEndpoint: string

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

Inherited from ​

AltairWindowOptions.subscriptionsEndpoint

subscriptionsProtocol? ​

optional subscriptionsProtocol: string

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

Inherited from ​

AltairWindowOptions.subscriptionsProtocol