Set of methods for operating HTTP requests

In an eitri-app, it's important to note that it's only possible to make HTTP requests through these commands. The format is similar to a well-known library called axios.

Hierarchy

  • Http

Methods

  • Performs an HTTP POST request

    Works similarly to axios

    Notes: Only HTTPS requests are accepted

    You can pass an authentication header through the headers field

    Example:

    Eitri.http.post('https://myaddress.com',
    {
    myData: "value of my data"
    },
    {
    "headers": {"Content-Type": "application/json"}
    }
    )

    Compatibility Control

    • API LEVEL 1 - Functionality added
    • API LEVEL 3 - Adds support for multipart/form-data
    • API LEVEL 12 - Adds support for application/x-www-form-urlencoded

    Parameters

    • url: string

      HTTP address for the request

    • Optional data: any

      Data to be sent

    • Optional config: HttpConfig

      Additional configurations for the request

    Returns Promise<HttpResponse>

  • Performs an HTTP GET request

    Works similarly to axios

    Notes:

    Only HTTPS requests are accepted

    You can pass an authentication header through the headers

    Example:

    Eitri.http.get('https://myaddress.com')
    

    Compatibility Control

    • API LEVEL 1 - Functionality added

    Parameters

    • url: string

      HTTP address for the request

    • Optional config: HttpConfig

      Additional configurations for the request

    Returns Promise<HttpResponse>

  • Performs an HTTP DELETE request

    Works similarly to axios

    Notes: Only HTTPS requests are accepted

    You can pass an authentication header through the headers

    Example:

    Eitri.http.delete('https://myaddress.com', { "headers": { "Content-Type": "application/json" } } )
    

    Compatibility Control

    • API LEVEL 1 - Functionality added

    Parameters

    • url: string

      HTTP address for the request

    • Optional config: HttpConfig

      Additional configurations for the request

    Returns Promise<HttpResponse>

  • Performs an HTTP PUT request

    Works similarly to axios

    Notes: Only HTTPS requests are accepted

    You can pass an authentication header through the headers

    Example:

    Eitri.http.put('https://myaddress.com',
    {
    myData: "value of my data"
    },
    {
    "headers": {"Content-Type": "application/json"}
    }
    )

    Compatibility Control

    • API LEVEL 1 - Functionality added
    • API LEVEL 3 - Adds support for multipart/form-data
    • API LEVEL 12 - Adds support for application/x-www-form-urlencoded

    Parameters

    • url: string

      HTTP address for the request

    • Optional data: any

      Data to be sent

    • Optional config: HttpConfig

      Additional configurations for the request

    Returns Promise<HttpResponse>

  • Performs an HTTP PATCH request

    Works similarly to axios

    Notes: Only HTTPS requests are accepted

    You can pass an authentication header through the headers

    Example:

    Eitri.http.patch('https://myaddress.com',
    {
    myData: "value of my data"
    },
    {
    "headers": {"Content-Type": "application/json"}
    }
    )

    Compatibility Control

    • API LEVEL 1 - Functionality added
    • API LEVEL 3 - Adds support for multipart/form-data
    • API LEVEL 12 - Adds support for application/x-www-form-urlencoded

    Parameters

    • url: string

      HTTP address for the request

    • Optional data: any

      Data to be sent

    • Optional config: HttpConfig

      Additional configurations for the request

    Returns Promise<HttpResponse>

  • Performs an HTTP HEAD request

    Works similarly to axios

    Notes: Only HTTPS requests are accepted

    You can pass an authentication header through the headers

    Example:

    Eitri.http.head('https://myaddress.com', {"headers": {"Content-Type": "application/json"}})
    

    Compatibility Control

    • API LEVEL 1 - Functionality added

    Parameters

    • url: string

      HTTP address for the request

    • Optional config: HttpConfig

      Additional configurations for the request

    Returns Promise<HttpResponse>

  • Performs an HTTP OPTIONS request

    Works similarly to axios

    Notes: Only HTTPS requests are accepted

    You can pass an authentication header through the headers

    Example:

    Eitri.http.options('https://myaddress.com', { "headers": { "Content-Type": "application/json" } } )
    

    Compatibility Control

    • API LEVEL 1 - Functionality added

    Parameters

    • url: string

      HTTP address for the request

    • Optional config: HttpConfig

      Additional configurations for the request

    Returns Promise<HttpResponse>

  • Performs a general purpose HTTP request using Axios syntax

    Works similarly to axios

    Notes: Only HTTPS requests are accepted

    Example:

    const requestConfig = {
    url: "https://myaddress.com",
    method: "POST",
    headers: { "Content-Type": "application/json" },
    timeout: 5000,
    data: { foo: "bar"},
    }

    Eitri.http.request(requestConfig)

    Compatibility Control

    • API LEVEL 1 - Functionality added

    Parameters

    Returns Promise<HttpResponse>

  • Performs a general purpose HTTP request using fetch syntax

    Works similarly to fetch

    Notes:

    Only HTTPS requests are accepted

    Signals are not supported, use timeout property

    Example:

    Eitri.http.fetch("https://myaddress.com", {
    method: "POST",
    body: { foo: "bar"},
    timeout: 1000 * 5,
    })

    Compatibility Control

    • API LEVEL 1 - Functionality added

    Parameters

    Returns Promise<FetchResponse>

Generated using TypeDoc