Kotlin JS GitHub Action SDK/com.rnett.action.httpclient

Package-level declarations

Wrappers for @actions/http-client.

Types

BaseHttpClient

interface BaseHttpClient<out T : HttpResponse>

A minimal HTTP client, based on @actions/http-client.

BasicAuthHandler

data class BasicAuthHandler(val username: String, val password: String) : HeaderProvider

Request handler for basic auth.

BearerAuthHandler

data class BearerAuthHandler(val token: String) : HeaderProvider

Request handler for bearer auth.

HeaderProvider

fun interface HeaderProvider : RequestHandler

An object or lambda that provides some headers.

Headers

interface Headers

Read-only non case sensitive HTTP headers.

HttpClient

typealias HttpClient = BaseHttpClient<*>

A HTTP client, based on @actions/http-client.

HttpClientBuilder

class HttpClientBuilder

A builder for http client configuration.

HttpClientImpl

class ~~HttpClientImpl~~ : BaseHttpClient<HttpResponse>

A HTTP client, based on @actions/http-client.

HttpResponse

interface HttpResponse

The response from a HTTP request.

JSTypedHttpResponse

class ~~JSTypedHttpResponse~~<T>

A typed HTTP response. All casting is done in JS, so this is not type safe.

MutableHeaders

interface MutableHeaders : Headers

Mutable non case sensitive HTTP headers.

PersonalAccessTokenAuthHandler

data class PersonalAccessTokenAuthHandler(val token: String) : HeaderProvider

Request handler for personal access token auth.

RequestHandler

fun interface RequestHandler

A handler that modifies outgoing requests and optionally handles authentication on 401s.

Functions

githubProxyUrl

fun githubProxyUrl(url: String): String

Get the GitHub actions proxy URL.

HttpClient

inline fun HttpClient(builder: HttpClientBuilder.() -> Unit = {}): HttpClient

A HTTP client, based on @actions/http-client.

plus

operator fun Map<String, String>.plus(header: HeaderProvider): Map<String, String>

toMap

fun HeaderProvider.toMap(): Map<String, String>

use

inline fun <R, T : BaseHttpClient<*>> T.use(block: (T) -> R): R

Use a HTTP client, then close it in finally block. Like JVM's use.