Interface JsonApiQuery<T>

A JSON:API URL query string.

interface JsonApiQuery<T extends JsonApiQueryTypes> {
    fields?: Record<string, string[]>;
    filter?: Record<
        string,
        {
            eq?: T["filterValue"];
            gt?: T["filterValue"];
            gte?: T["filterValue"];
            lt?: T["filterValue"];
            lte?: T["filterValue"];
            ne?: T["filterValue"];
        },
    >;
    include?: string[];
    page?: {
        cursor?: T["pageValue"];
        limit?: T["pageValue"];
        number?: T["pageValue"];
        offset?: T["pageValue"];
        size?: T["pageValue"];
    };
    sort?: string[];
}

Type Parameters

Properties

fields? filter? include? page? sort?

Properties

Optionalfields

fields?: Record<string, string[]>

Fields to include in the response.

See

JSON:API sparse fieldsets

Optionalfilter

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

Filters to apply to the query.

See

Optionalinclude

include?: string[]

Relationships to include in the response.

See

JSON:API fetching includes

Optionalpage

page?: {
    cursor?: T["pageValue"];
    limit?: T["pageValue"];
    number?: T["pageValue"];
    offset?: T["pageValue"];
    size?: T["pageValue"];
}

Pagination data.

See

Optionalsort

sort?: string[]

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

See

JSON:API sorting

Settings

Member Visibility

On This Page

Properties