supabase-kt/io.github.jan.supabase

Package-level declarations

Types

AccessTokenProvider

typealias AccessTokenProvider = suspend () -> String?

Optional function for using a third-party authentication system with Supabase. The function should return an access token or ID token (JWT) by obtaining it from the third-party auth client library. Note that this function may be called concurrently and many times. Use memoization and locking techniques if this is not supported by the client libraries.

object BuildConfig

data class OSInformation(val name: String, val version: String)

enum PlatformTarget : Enum<PlatformTarget>

Represents a target platform

interface SupabaseClient

The main class to interact with Supabase.

SupabaseClientBuilder

class SupabaseClientBuilder

Creates a new SupabaseClient with the given options.

SupabaseSerializer

interface SupabaseSerializer

An interface for serializing and deserializing objects. Note: Internally, KotlinX Serialization will always be used.

Properties

CurrentPlatformTarget

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

expect val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

actual val CurrentPlatformTarget: PlatformTarget

The current target platform

defaultDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

actual val defaultDispatcher: CoroutineDispatcher

val supabaseJson: Json

Functions

inline suspend fun <T> HttpResponse.bodyOrNull(): T?

inline fun buildUrl(baseUrl: String, init: URLBuilder.() -> Unit): String

createSupabaseClient

inline fun createSupabaseClient(supabaseUrl: String, supabaseKey: String, builder: SupabaseClientBuilder.() -> Unit): SupabaseClient

Creates a new SupabaseClient instance using builder

inline fun <T : Any> SupabaseSerializer.decode(value: String): T

Decodes the given value to an object of type T

decodeIfNotEmptyOrDefault

inline fun <T> JsonObject.decodeIfNotEmptyOrDefault(default: T): T

inline fun <T : Any> SupabaseSerializer.encode(value: T): String

Encodes the given value to a string

encodeToJsonElement

inline fun <T : Any> SupabaseSerializer.encodeToJsonElement(value: T): JsonElement

Encodes the given value to a JsonElement

fun JsonObjectBuilder.putJsonObject(jsonObject: JsonObject)

readProcVersion

fun readProcVersion(): String?

inline suspend fun <T> HttpResponse.safeBody(context: String? = null): T

fun String.toJsonObject(): JsonObject