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[];
}

Properties

fields? filter? include? page? sort?

Properties

Optionalfields

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

Fields to include in the response.

See

JSON:API sparse fieldsets

Optionalfilter

filter?: Record<
    string,
    undefined
    | FilterValue
    | FilterValue[]
    | FilterObject
    | NestedFilter,
>

Filters to apply to the query.

See

Optionalinclude

include?: string | string[]

Relationships to include in the response.

See

JSON:API fetching includes

Optionalpage

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

Pagination data.

See

Optionalsort

sort?: string | string[]

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

See

JSON:API sorting

Settings

Member Visibility

On This Page

Properties