Zum Hauptinhalt springen

HttpClient

Wrapper Class for HTTP calls.

context.enableModules();
const { HttpClient } = require("ou.sp.HttpClient");

const client = new HttpClient();
const result = client.get("https://one-unity.de");
context.returnValue = result.data;

HttpClient

Constructors

Constructor

new HttpClient(): HttpClient

Returns

HttpClient

Methods

get()

get(url, config?): HttpClientResponse

Executes a GET HTTP Request by given url.

context.enableModules();
const { HttpClient } = require("ou.sp.HttpClient");

const client = new HttpClient();
const result = client.get("https://one-unity.de");
context.returnValue = result.data;

Parameters

url

string

URL that will be used for the request

config?

HttpClientConfig

Returns

HttpClientResponse


post()

post(url, data?, config?): HttpClientResponse

Parameters

url

string

data?

HttpClientRequestData

config?

HttpClientConfig

Returns

HttpClientResponse


put()

put(url, data?, config?): HttpClientResponse

Parameters

url

string

data?

HttpClientRequestData

config?

HttpClientConfig

Returns

HttpClientResponse


delete()

delete(url, config?): HttpClientResponse

Parameters

url

string

config?

HttpClientConfig

Returns

HttpClientResponse


request()

request(config?): HttpClientResponse

Parameters

config?

HttpClientConfig

Returns

HttpClientResponse


getSearchParams()

static getSearchParams(params): string

Parameters

params

Record<string, AllowedSearchParamTypes>

Returns

string