core-utils
    Preparing search index...

    Interface ClientJsonApiQuery

    A JSON:API URL query.

    interface ClientJsonApiQuery {
        fields?: Record<string, string | string[]>;
        filter?: Record<
            string,
            undefined
            | FilterValue
            | FilterValue[]
            | FilterObject
            | NestedFilter,
        >;
        include?: string | string[];
        page?: {
            cursor?: string | number;
            limit?: string | number;
            number?: string | number;
            offset?: string | number;
            size?: string | number;
        };
        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,
        undefined
        | FilterValue
        | FilterValue[]
        | FilterObject
        | NestedFilter,
    >

    Filters to apply to the query.

    include?: string | string[]

    Relationships to include in the response.

    JSON:API fetching includes

    Optionalpage

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

    Pagination data.

    sort?: string | string[]

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

    JSON:API sorting

    Settings

    Member Visibility

    On This Page

    Properties