kotlin-actions-toolkit/actions.http.client/HttpClient

HttpClient

Constructors

constructor(userAgent: String = definedExternally, handlers: ReadonlyArray<RequestHandler> = definedExternally, requestOptions: RequestOptions = definedExternally)

Properties

handlers

var handlers: ReadonlyArray<RequestHandler>

requestOptions

var requestOptions: RequestOptions?

userAgent

var userAgent: String?

Functions

del

fun del(requestUrl: String, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

dispose

fun dispose()

Needs to be called if keepAlive is set to true in request options.

get

fun get(requestUrl: String, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

getAgent

fun getAgent(serverUrl: String): Agent

Gets an http agent. This function is useful when you need an http agent that handles routing through a proxy server - depending upon the url and proxy environment variables.

getAgentDispatcher

fun getAgentDispatcher(serverUrl: String): Any?

getJson

fun <T> getJson(requestUrl: String, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<TypedResponse<T>>

Gets a typed object from an endpoint Be aware that not found returns a null. Other errors (4xx, 5xx) reject the promise

head

fun head(requestUrl: String, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

options

fun options(requestUrl: String, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

patch

fun patch(requestUrl: String, data: String, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

patchJson

fun <T> patchJson(requestUrl: String, obj: Any?, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<TypedResponse<T>>

post

fun post(requestUrl: String, data: String, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

postJson

fun <T> postJson(requestUrl: String, obj: Any?, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<TypedResponse<T>>

put

fun put(requestUrl: String, data: String, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

putJson

fun <T> putJson(requestUrl: String, obj: Any?, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<TypedResponse<T>>

request

fun request(verb: String, requestUrl: String, data: String?, headers: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

Makes a raw http request. All other methods such as get, post, patch, and request ultimately call this. Prefer get, del, post and patch

fun request(verb: String, requestUrl: String, data: ReadableStream?, headers: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>

requestRaw

fun requestRaw(info: RequestInfo, data: String?): Promise<HttpClientResponse>

Raw request.

fun requestRaw(info: RequestInfo, data: ReadableStream?): Promise<HttpClientResponse>

requestRawWithCallback

fun requestRawWithCallback(info: RequestInfo, data: String?, onResult: (JsError?, res: HttpClientResponse?) -> Unit)

Raw request with callback.

fun requestRawWithCallback(info: RequestInfo, data: ReadableStream?, onResult: (JsError?, res: HttpClientResponse?) -> Unit)

sendStream

fun sendStream(verb: String, requestUrl: String, stream: ReadableStream, additionalHeaders: OutgoingHttpHeaders = definedExternally): Promise<HttpClientResponse>