Interface CompoundQueryFormat<SubQueryType, CommonArguments>

Virtual Query Format. Grouping query parameters of the same type (re-specified in the query field).

interface CompoundQueryFormat<
    SubQueryType extends SupportedQueryTypes,
    CommonArguments extends VirtualCompoundConstraint<SubQueryType>,
> {
    arguments: readonly (
        StrictOmit<
            StrictOmit<QueryArgumentsWithType<SubQueryType>, "type">,
            CommonArguments,
        > & Partial<QueryArgumentsWithType<SubQueryType>>
    )[];
    commonArguments: Pick<
        QueryArgumentsWithType<SubQueryType>,
        CommonArguments,
    >;
    query: SubQueryType;
    type: "compound";
}

Type Parameters

Hierarchy (View Summary)

Hierarchy-Diagram

UML class diagram of CompoundQueryFormat

Properties

arguments commonArguments query type

Properties

Readonlyarguments

arguments: readonly (
    StrictOmit<
        StrictOmit<QueryArgumentsWithType<SubQueryType>, "type">,
        CommonArguments,
    > & Partial<QueryArgumentsWithType<SubQueryType>>
)[]

You do not have to re-state the type, this is automatically filled with the type for 'query' Additionally all arguments given in commonArguments are now enforced optional.

ReadonlycommonArguments

commonArguments: Pick<QueryArgumentsWithType<SubQueryType>, CommonArguments>

defaults to use the same arguments for all queries

Readonlyquery

query: SubQueryType

Readonlytype

type: "compound"

used to select the query type :)

Settings

Member Visibility

On This Page

Properties