quarkdown-core/com.quarkdown.core.function

Package-level declarations

Types

A function that can be called from a Quarkdown source via a FunctionCall.

data class FunctionParameter(val name: String, val type: ParameterType, val index: Int, val isOptional: Boolean = false, val isExplicitlyBody: Boolean = false, val isInjected: Boolean = false, val isNullable: Boolean = false, val convert: ArgumentConverter? = null)

A declared Function parameter.

InjectionKind

enum InjectionKind : Enum<InjectionKind>

What an ParameterType.Injected parameter receives.

ParameterType

sealed interface ParameterType

The kind of value a FunctionParameter accepts.

SimpleFunction

data class SimpleFunction<T : OutputValue<*>>(val name: String, val parameters: List<FunctionParameter>, val validators: List<FunctionCallValidator<T>> = emptyList(), val invoke: (ArgumentBindings, FunctionCall<T>) -> T) : Function<T>

A basic Function implementation.

Properties

quarkdownName

val Enum<*>.quarkdownName: String

Functions

signatureAsString

fun Function<*>.signatureAsString(includeName: Boolean = true): String

Renders this function's signature as a human-readable string. Injected parameters (FunctionParameter.isInjected) are omitted — they aren't part of the surface that callers see and shouldn't clutter the rendered signature.

toQuarkdownNamingFormat

fun String.toQuarkdownNamingFormat(): String