Interface HttpApi

This API provides functionality for making REST requests.

Accessed from the window at window.sas.vi.http

Example

window.sas.vi.http.get("example_url", {...})

interface HttpApi {
    delete(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "text";
    }): Promise<HttpResponse<string>>;
    delete<R>(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "json";
    }): Promise<HttpResponse<R>>;
    delete(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "blob";
    }): Promise<HttpResponse<Blob>>;
    get(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "text";
    }): Promise<HttpResponse<string>>;
    get<R>(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "json";
    }): Promise<HttpResponse<R>>;
    get(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "blob";
    }): Promise<HttpResponse<Blob>>;
    head(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
    }): Promise<HttpResponse<null>>;
    options(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "text";
    }): Promise<HttpResponse<string>>;
    options<R>(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "json";
    }): Promise<HttpResponse<R>>;
    options(url: string, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "blob";
    }): Promise<HttpResponse<Blob>>;
    patch(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "text";
    }): Promise<HttpResponse<string>>;
    patch<R>(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "json";
    }): Promise<HttpResponse<R>>;
    patch(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "blob";
    }): Promise<HttpResponse<Blob>>;
    post(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "text";
    }): Promise<HttpResponse<string>>;
    post<R>(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "json";
    }): Promise<HttpResponse<R>>;
    post(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "blob";
    }): Promise<HttpResponse<Blob>>;
    put(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "text";
    }): Promise<HttpResponse<string>>;
    put<R>(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "json";
    }): Promise<HttpResponse<R>>;
    put(url: string, body: any, options?: {
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "blob";
    }): Promise<HttpResponse<Blob>>;
    request(method: string, url: string, options?: {
        body?: any;
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "text";
    }): Promise<HttpResponse<string>>;
    request<R>(method: string, url: string, options?: {
        body?: any;
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "json";
    }): Promise<HttpResponse<R>>;
    request(method: string, url: string, options?: {
        body?: any;
        headers?: Record<string, string | string[]>;
        params?: Record<string, string | string[]>;
        responseType: "blob";
    }): Promise<HttpResponse<Blob>>;
}

Index

Methods

delete get head options patch post put request

Methods

delete

delete(url, options?): Promise<HttpResponse<string>>
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "text";
  }
  {HttpApi~StringRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "text"
Returns Promise<HttpResponse<string>>
A Promise of the HttpResponse for the request. The response body is a string.

Method
Description
Constructs a DELETE request that interprets the body as a text stream and returns the full HttpResponse.
delete<R>(url, options?): Promise<HttpResponse<R>>
Type Parameters
- R
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "json";
  }
  {HttpApi~JsonRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "json"
Returns Promise<HttpResponse<R>>
A Promise of the HttpResponse for the request. The response body is an object of type R.

Method
Description
Constructs a DELETE request that interprets the body as a JSON object and returns the full HttpResponse.
delete(url, options?): Promise<HttpResponse<Blob>>
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "blob";
  }
  {HttpApi~BlobRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "blob"
Returns Promise<HttpResponse<Blob>>
A Promise of the HttpResponse for the request. The response body is a Blob.

Method
Description
Constructs a DELETE request that interprets the body as a Blob and returns the full HttpResponse.

get

get(url, options?): Promise<HttpResponse<string>>
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "text";
  }
  {HttpApi~StringRequestOptions} HTTP options to send with the request.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "text"
Returns Promise<HttpResponse<string>>
A Promise of the HttpResponse for the request. The response body is a string.

Method
Description
Constructs a GET request that interprets the body as a text stream and returns the full HttpResponse.
get<R>(url, options?): Promise<HttpResponse<R>>
Type Parameters
- R
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "json";
  }
  {HttpApi~JsonRequestOptions} HTTP options to send with the request.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "json"
Returns Promise<HttpResponse<R>>
A Promise of the HttpResponse for the request. The response body is an object of type R.

Method
Description
Constructs a GET request that interprets the body as a JSON object and returns the full HttpResponse.
get(url, options?): Promise<HttpResponse<Blob>>
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "blob";
  }
  {HttpApi~BlobRequestOptions} HTTP options to send with the request.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "blob"
Returns Promise<HttpResponse<Blob>>
A Promise of the HttpResponse for the request. The response body is a Blob.

Method
Description
Constructs a GET request that interprets the body as a Blob and returns the full HttpResponse.

head

head(url, options?): Promise<HttpResponse<null>>
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
  headers?: Record<string, string | string[]>;
  params?: Record<string, string | string[]>;
  }
  {HttpApi~HeadOptions} HTTP options to send with the request.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
Returns Promise<HttpResponse<null>>
A Promise of the HttpResponse for the request with the response body of null.

Method
Description
Constructs a HEAD request that returns a null body and the full HttpResponse.

options

options(url, options?): Promise<HttpResponse<string>>
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "text";
  }
  {HttpApi~StringRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "text"
Returns Promise<HttpResponse<string>>
A Promise of the HttpResponse for the request. The response body is a string.

Method
Description
Constructs an OPTIONS request that interprets the body as a text stream and returns the full HttpResponse.
options<R>(url, options?): Promise<HttpResponse<R>>
Type Parameters
- R
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "json";
  }
  {HttpApi~JsonRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "json"
Returns Promise<HttpResponse<R>>
A Promise of the HttpResponse for the request. The response body is an object of type R.

Method
Description
Constructs an OPTIONS request that interprets the body as a JSON object and returns the full HttpResponse.
options(url, options?): Promise<HttpResponse<Blob>>
Parameters
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "blob";
  }
  {HttpApi~BlobRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "blob"
Returns Promise<HttpResponse<Blob>>
A Promise of the HttpResponse for the request. The response body is a Blob.

Method
Description
Constructs an OPTIONS request that interprets the body as a Blob and returns the full HttpResponse.

patch

patch(url, body, options?): Promise<HttpResponse<string>>
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "text";
  }
  {HttpApi~StringRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "text"
Returns Promise<HttpResponse<string>>
A Promise of the HttpResponse for the request. The response body is a string.

Method
Description
Constructs a PATCH request that interprets the body as a text stream and returns the full HttpResponse.
patch<R>(url, body, options?): Promise<HttpResponse<R>>
Type Parameters
- R
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "json";
  }
  {HttpApi~JsonRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "json"
Returns Promise<HttpResponse<R>>
A Promise of the HttpResponse for the request. The response body is an object of type R.

Method
Description
Constructs a PATCH request that interprets the body as a JSON object and returns the full HttpResponse.
patch(url, body, options?): Promise<HttpResponse<Blob>>
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "blob";
  }
  {HttpApi~BlobRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "blob"
Returns Promise<HttpResponse<Blob>>
A Promise of the HttpResponse for the request. The response body is a Blob.

Method
Description
Constructs a PATCH request that interprets the body as a Blob and returns the full HttpResponse.

post

post(url, body, options?): Promise<HttpResponse<string>>
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "text";
  }
  {HttpApi~StringRequestOptions} HTTP options
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "text"
Returns Promise<HttpResponse<string>>
A Promise of the HttpResponse for the request. The response body is a string.

Method
Description
Constructs a POST request that interprets the body as a text stream and returns the full HttpResponse.
post<R>(url, body, options?): Promise<HttpResponse<R>>
Type Parameters
- R
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "json";
  }
  {HttpApi~JsonRequestOptions} HTTP options
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "json"
Returns Promise<HttpResponse<R>>
A Promise of the HttpResponse for the request. The response body is an object of type R.

Method
Description
Constructs a POST request that interprets the body as a JSON object and returns the full HttpResponse.
post(url, body, options?): Promise<HttpResponse<Blob>>
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "blob";
  }
  {HttpApi~BlobRequestOptions} HTTP options
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "blob"
Returns Promise<HttpResponse<Blob>>
A Promise of the HttpResponse for the request. The response body is a Blob.

Method
Description
Constructs a POST request that interprets the body as a Blob and returns the full HttpResponse.

put

put(url, body, options?): Promise<HttpResponse<string>>
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "text";
  }
  {HttpApi~StringRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "text"
Returns Promise<HttpResponse<string>>
A Promise of the HttpResponse for the request. The response body is a string.

Method
Description
Constructs a PUT request that interprets the body as a text stream and returns the full HttpResponse.
put<R>(url, body, options?): Promise<HttpResponse<R>>
Type Parameters
- R
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "json";
  }
  {HttpApi~JsonRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "json"
Returns Promise<HttpResponse<R>>
A Promise of the HttpResponse for the request. The response body is an object of type R.

Method
Description
Constructs a PUT request that interprets the body as a JSON object and returns the full HttpResponse.
put(url, body, options?): Promise<HttpResponse<Blob>>
Parameters
- url: string
  {string} Endpoint URL.
- body: any
  {(any|null)} Content to replace with current content.
- Optionaloptions: {
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "blob";
  }
  {HttpApi~BlobRequestOptions} HTTP options.
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "blob"
Returns Promise<HttpResponse<Blob>>
A Promise of the HttpResponse for the request. The response body is a Blob.

Method
Description
Constructs a PUT request that interprets the body as a Blob and returns the full HttpResponse.

request

request(method, url, options?): Promise<HttpResponse<string>>
Parameters
- method: string
  {string}
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      body?: any;
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "text";
  }
  {HttpApi~StringGenericRequestOptions} HTTP options.
  - Optionalbody?: any
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "text"
Returns Promise<HttpResponse<string>>
A Promise of the HttpResponse for the request. The response body is a string.

Method
Description
Constructs a request that interprets the body as a text stream and returns the full HttpResponse.
request<R>(method, url, options?): Promise<HttpResponse<R>>
Type Parameters
- R
Parameters
- method: string
  {string}
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      body?: any;
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "json";
  }
  {HttpApi~JsonGenericRequestOptions} HTTP options.
  - Optionalbody?: any
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "json"
Returns Promise<HttpResponse<R>>
A Promise of the HttpResponse for the request. The response body is an object of type R.

Method
Description
Constructs a request that interprets the body as a JSON object and returns the full HttpResponse.
request(method, url, options?): Promise<HttpResponse<Blob>>
Parameters
- method: string
  {string}
- url: string
  {string} Endpoint URL.
- Optionaloptions: {
      body?: any;
      headers?: Record<string, string | string[]>;
      params?: Record<string, string | string[]>;
      responseType: "blob";
  }
  {HttpApi~BlobGenericRequestOptions} HTTP options.
  - Optionalbody?: any
  - Optionalheaders?: Record<string, string | string[]>
  - Optionalparams?: Record<string, string | string[]>
  - responseType: "blob"
Returns Promise<HttpResponse<Blob>>
A Promise of the HttpResponse for the request. The response body is a Blob.

Method
Description
Constructs a request that interprets the body as a Blob and returns the full HttpResponse.

Interface HttpApi

Example

Index

Methods

Methods

delete

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "text"

Returns Promise<HttpResponse<string>>

Method

Description

Type Parameters

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "json"

Returns Promise<HttpResponse<R>>

Method

Description

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "blob"

Returns Promise<HttpResponse<Blob>>

Method

Description

get

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "text"

Returns Promise<HttpResponse<string>>

Method

Description

Type Parameters

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "json"

Returns Promise<HttpResponse<R>>

Method

Description

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "blob"

Returns Promise<HttpResponse<Blob>>

Method

Description

head

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

Returns Promise<HttpResponse<null>>

Method

Description

options

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "text"

Returns Promise<HttpResponse<string>>

Method

Description

Type Parameters

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "json"

Returns Promise<HttpResponse<R>>

Method

Description

Parameters

Optionalheaders?: Record<string, string | string[]>

Optionalparams?: Record<string, string | string[]>

responseType: "blob"

Returns Promise<HttpResponse<Blob>>

Method

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>

`Optional`headers?: Record<string, string | string[]>

`Optional`params?: Record<string, string | string[]>