Viaduct Tenant API/viaduct.api

Package-level declarations

This is the main package for the Viaduct Tenant API, containing the core interfaces and classes that tenants will use to implement their GraphQL schema behavior.

Types

ConnectionResolverBase

interface ConnectionResolverBase<O : Object, Q : Query, A : ConnectionArguments, R : Connection<*, *>?> : FieldResolverBase<O, Q, A, R>

Specialized resolver base for connection field resolvers. Extends FieldResolverBase with the additional constraint that A is a ConnectionArguments, exposing pagination utilities.

FieldResolverBase

interface FieldResolverBase<O : Object, Q : Query, A : Arguments, R> : ResolverBase<R>

Specialized resolver base for field resolvers. Exposes type parameters that allow the testing framework to infer parent object, query, and arguments types at compile time.

FieldValue

sealed interface FieldValue<out T>

Represents the value of a resolved GraphQL object field

MutationResolverBase

interface MutationResolverBase<Q : Query, M : Mutation, A : Arguments, R> : ResolverBase<R>

Specialized resolver base for mutation field resolvers. Mutations have no parent object, so this interface has no O parameter unlike FieldResolverBase.

NodeResolverBase

interface NodeResolverBase<T : NodeObject> : ResolverBase<T>

Specialized resolver base for node resolvers.

ResolverBase

interface ResolverBase<T>

Base interface for field resolver classes.

TenantModule

interface TenantModule

Marker interface for a Viaduct tenant module.

Functions

fetchOrDefault

inline suspend fun <T> fetchOrDefault(default: T, block: suspend () -> T): T

Executes the given block and returns its result, or default if an exception is thrown.

fetchOrNull

inline suspend fun <T> fetchOrNull(block: suspend () -> T): T?

Executes the given block and returns its result, or null if an exception is thrown.