Class Api

constructor

• new Api(apiConfig?): Api

• Parameters

  • OptionalapiConfig: ApiConfig

  Returns Api

Optionalapi

baseUrl

https://rest.spinque.com/
Copy

Optionalconfig

default
Copy

Optionalversion

4
Copy

Optionalworkspace

accessToken

• get accessToken(): undefined | string

• Returns undefined | string

apiConfig

• get apiConfig(): ApiConfig

• Getter for authentication configuration

  Returns ApiConfig

authentication

• get authentication(): undefined | ApiAuthenticationConfig

• Getter for authentication configuration

  Returns undefined | ApiAuthenticationConfig

fetch

• fetch<O, T, R>(queries, options?, requestType?, requestInit?): Promise<ResponseType<R, T>>

• Fetch a Query (or array of Queries). Takes optional RequestOptions and RequestType into account. Optionally the fetch RequestInit can be passed (see https://developer.mozilla.org/en-US/docs/Web/API/RequestInit).

  Type Parameters

  • O extends
        | CountAndOffset
        | ResultsRequestOptions
        | ResultItemRequestOptions
        | OptionsRequestOptions
  • T extends TupleTypes[] = TupleTypes[]
  • R extends RequestType = Results

  Parameters

  • queries: Query | Query[]
  • Optionaloptions: O
  • OptionalrequestType: R
  • requestInit: RequestInit = {}

  Returns Promise<ResponseType<R, T>>

fetchAccessToken

• fetchAccessToken(): Promise<undefined | AccessTokenResponse>

• Returns Promise<undefined | AccessTokenResponse>

fetchUrl

• fetchUrl<R>(url, requestInit?): Promise<R>

• Fetch a url directly, circumventing all Api configuration except authentication. Useful when wanting to tap into @spinque/query-api's authentication service while also wanting to construct your own URLs. This function does not check whether the provided URL is a valid request to Spinque, take caution.

  Type Parameters

  • R extends ResponseTypes

  Parameters

  • url: string
  • requestInit: RequestInit = {}

  Returns Promise<R>