core-utils
    Preparing search index...

    Interface ClientJsonApiQuery

    A JSON:API URL query.

    interface ClientJsonApiQuery {
        fields?: Record<string, string | string[]>;
        filter?: Record<
            string,
            | FilterValue
            | Partial<Record<FilterOperator, (FilterValue | FilterValue[])>>
            | NestedFilter
            | FilterValue[]
            | undefined,
        >;
        include?: string | string[];
        page?: Partial<Record<PageKey, 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,
        | FilterValue
        | Partial<Record<FilterOperator, (FilterValue | FilterValue[])>>
        | NestedFilter
        | FilterValue[]
        | undefined,
    >

    Filters to apply to the query.

    include?: string | string[]

    Relationships to include in the response.

    JSON:API fetching includes

    Optionalpage

    page?: Partial<Record<PageKey, 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