Altair GraphQL Client

Appearance

AltairConfig ​

Constructors ​

new AltairConfig() ​

new AltairConfig(__namedParameters: AltairConfigOptions): AltairConfig

Parameters ​

• __namedParameters: AltairConfigOptions= {}

Returns ​

AltairConfig

Properties ​

add_query_depth_limit ​

add_query_depth_limit: number = 3

cspNonce ​

cspNonce: string = ''

defaultTheme ​

defaultTheme: string = 'system'

default_language ​

default_language: string

disableLineNumbers ​

disableLineNumbers: boolean = false

donation ​

donation: object

action_count_threshold ​

action_count_threshold: number = 50

url ​

url: string = 'https://opencollective.com/altair/donate'

ga ​

ga: string = 'UA-41432833-6'

initialData ​

initialData: object

disableAccount ​

disableAccount: boolean = false

environments ​

environments: IInitialEnvironments

headers ​

headers: IDictionary

initialAuthorization ​

initialAuthorization: undefined | AuthorizationProviderInput

initialHttpMethod ​

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

initialRequestHandlerAdditionalParams ​

initialRequestHandlerAdditionalParams: Record<string, unknown>

initialRequestHandlerId ​

initialRequestHandlerId: RequestHandlerIds

initialSubscriptionRequestHandlerId ​

initialSubscriptionRequestHandlerId: undefined | RequestHandlerIds

initialSubscriptionsPayload ​

initialSubscriptionsPayload: IDictionary

instanceStorageNamespace ​

instanceStorageNamespace: string = 'altair_'

persistedSettings ​

persistedSettings: undefined | Partial<SettingsState>

postRequestScript ​

postRequestScript: string = ''

preRequestScript ​

preRequestScript: string = ''

preserveState ​

preserveState: boolean = true

query ​

query: string = ''

settings ​

settings: undefined | Partial<SettingsState>

subscriptionsEndpoint ​

subscriptionsEndpoint: string = ''

subscriptionsProtocol ​

subscriptionsProtocol: string = ''

url ​

url: string = ''

variables ​

variables: string = ''

windows ​

windows: AltairWindowOptions[]

isTranslateMode ​

isTranslateMode: any

isWebApp ​

isWebApp: any

languages ​

languages: object

cs-CZ ​

cs-CZ: string = 'Czech'

de-DE ​

de-DE: string = 'German'

en-US ​

en-US: string = 'English'

es-ES ​

es-ES: string = 'Español'

fr-FR ​

fr-FR: string = 'French'

it-IT ​

it-IT: string = 'Italian'

ja-JP ​

ja-JP: string = 'Japanese'

ko-KR ​

ko-KR: string = 'Korean'

pl-PL ​

pl-PL: string = 'Polish'

pt-BR ​

pt-BR: string = 'Brazilian'

ro-RO ​

ro-RO: string = 'Romanian'

ru-RU ​

ru-RU: string = 'Russian'

sr-SP ​

sr-SP: string = 'Serbian'

uk-UA ​

uk-UA: string = 'Ukrainian'

vi-VN ​

vi-VN: string = 'Vietnamese'

zh-CN ​

zh-CN: string = 'Chinese Simplified'

max_windows ​

max_windows: number

query_history_depth ​

query_history_depth: number

tab_size ​

tab_size: number = 2

themes ​

themes: string[]

Methods ​

getUrl() ​

getUrl(name: keyof UrlConfig, environment: ConfigEnvironment): Promise<string>

Parameters ​

• name: keyof UrlConfig

• environment: ConfigEnvironment= 'production'

Returns ​

Promise<string>

getUrlConfig() ​

getUrlConfig(environment: ConfigEnvironment): UrlConfig

Parameters ​

• environment: ConfigEnvironment= 'production'

Returns ​

UrlConfig

getUrlConfigWithLocal() ​

getUrlConfigWithLocal(environment: ConfigEnvironment): Promise<UrlConfig>

Parameters ​

• environment: ConfigEnvironment= 'production'

Returns ​

Promise<UrlConfig>