functions-kt/io.github.jan.supabase.functions/Functions

Functions

class Functions(val config: Functions.Config, val supabaseClient: SupabaseClient) : MainPlugin<Functions.Config> , CustomSerializationPlugin(source)

Plugin to interact with the supabase Edge Functions API

To use it you need to install it to the SupabaseClient:

val supabase = createSupabaseClient(supabaseUrl, supabaseKey) {
   install(Functions)
}

then you can use it like this:

val response = supabase.functions("myFunction")
//or store it in a variable
val function = supabase.functions.buildEdgeFunction("myFunction")
val response = function()

Constructors

Functions

constructor(config: Functions.Config, supabaseClient: SupabaseClient)

Types

Companion

object Companion : SupabasePluginProvider<Functions.Config, Functions>

Config

class Config : MainConfig, CustomSerializationConfig, AuthDependentPluginConfig

The config for the Functions plugin

Properties

apiVersion

open override val apiVersion: Int

config

open override val config: Functions.Config

pluginKey

open override val pluginKey: String

serializer

open override val serializer: SupabaseSerializer

supabaseClient

open override val supabaseClient: SupabaseClient

Functions

buildEdgeFunction

fun buildEdgeFunction(function: String, region: FunctionRegion = config.defaultRegion, headers: Headers = Headers.Empty): EdgeFunction

Builds an EdgeFunction which can be invoked multiple times

open suspend fun close()

init

open fun init()

invoke

inline suspend operator fun invoke(function: String, region: FunctionRegion = config.defaultRegion, headers: Headers = Headers.Empty): HttpResponse

inline suspend operator fun invoke(function: String, region: FunctionRegion = config.defaultRegion, crossinline builder: HttpRequestBuilder.() -> Unit): HttpResponse

Invokes a remote edge function. The authorization token is automatically added to the request.

inline suspend operator fun <T : Any> invoke(function: String, body: T, region: FunctionRegion = config.defaultRegion, headers: Headers = Headers.Empty): HttpResponse

Invokes a remote edge function. The authorization token is automatically added to the request. Note, if you want to serialize body to json, you need to add the HttpHeaders.ContentType header yourself.

invokeSSE

fun invokeSSE(function: String, region: FunctionRegion = config.defaultRegion, builder: HttpRequestBuilder.() -> Unit = {}): Flow<FunctionServerSentEvent>

Invokes a remote edge function that returns Server-Sent Events (SSE) and returns a Flow of FunctionServerSentEvent. Each event provides access to data, event, and id fields, as well as a decodeAs method for deserializing the data payload.

parseErrorResponse

open suspend override fun parseErrorResponse(response: HttpResponse): RestException

prepareInvoke

inline suspend fun prepareInvoke(function: String, region: FunctionRegion = config.defaultRegion, crossinline builder: HttpRequestBuilder.() -> Unit = {}): HttpStatement

Prepares an invocation of a remote edge function, returning an HttpStatement for streaming or other advanced response handling. The authorization token is automatically added to the request.

resolveUrl

open fun resolveUrl(path: String): String