QueryPairField

class QueryPairField<A, B>(val fieldA: QueryField<A>, val fieldB: QueryField<B>) : KovenPairField<A, B> , QueryField<KovenPair<A, B>>

A query field that combines two other query fields.

Constructors

Link copied to clipboard
constructor(fieldA: QueryField<A>, fieldB: QueryField<B>)

Properties

Link copied to clipboard
open override val fieldA: QueryField<A>
Link copied to clipboard
open override val fieldB: QueryField<B>
Link copied to clipboard
open override val fields: List<String>

The field name(s) for this field.

Link copied to clipboard
open val name: String

Display name for this field, derived from fields.

Functions

Link copied to clipboard
@JvmName(name = "andEmptyQueryFieldRight")
infix fun <A> QueryField<A>.and(other: Empty): QueryField<A>

Creates a pair of query fields as QueryPairField, optimizing for Empty on the right.

infix fun <A, B> QueryField<A>.and(other: QueryField<B>): QueryPairField<A, B>

Creates a pair of query fields as QueryPairField.

Link copied to clipboard
open fun create(value: KovenPair<A, B>): QueryParams

Creates a QueryParams object from the given value.

Link copied to clipboard
context(_: Raise<Issue>)
open override fun decode(params: QueryParams): KovenPair<A, B>
Link copied to clipboard
open override fun encodeQuery(value: KovenPair<A, B>): Map<String, List<String>>
Link copied to clipboard
open override fun flatten(): List<QueryField<*>>

Flattens the field into its constituent fields.

Link copied to clipboard

Marks a query field as optional.