core-utils
    Preparing search index...

    Interface ServerJsonApiQuery

    A JSON:API URL query.

    interface ServerJsonApiQuery {
        fields?: Record<string, string | string[]>;
        filter?: Record<
            string,
            | string
            | string[]
            | {
                eq?: string
                | string[];
                gt?: string | string[];
                gte?: string | string[];
                lt?: string | string[];
                lte?: string | string[];
                ne?: string | string[];
            },
        >;
        include?: string
        | string[];
        page?: {
            cursor?: string;
            limit?: string;
            number?: string;
            offset?: string;
            size?: string;
        };
        sort?: string
        | string[];
    }
    Index

    Properties

    fields? filter? include? page? sort?

    Properties

    fields?: Record<string, string | string[]>

    Fields to include in the response.

    JSON:API sparse fieldsets

    filter?: Record<
        string,
        | string
        | string[]
        | {
            eq?: string
            | string[];
            gt?: string | string[];
            gte?: string | string[];
            lt?: string | string[];
            lte?: string | string[];
            ne?: string | string[];
        },
    >

    Filters to apply to the query.

    include?: string | string[]

    Relationships to include in the response.

    JSON:API fetching includes

    Optionalpage

    page?: {
        cursor?: string;
        limit?: string;
        number?: string;
        offset?: string;
        size?: string;
    }

    Pagination data.

    sort?: string | string[]

    Sorting data. Include the "-" prefix for descending order.

    JSON:API sorting

    Settings

    Member Visibility

    On This Page

    Properties