Interface PagedQueryResponse

interface PagedQueryResponse {
    count: number;
    limit: number;
    meta?: any;
    offset: number;
    results: BaseResource[];
    total?: number;
}

Properties

count limit meta? offset results total?

Properties

Readonly count

count: number

Actual number of results returned.

Readonly limit

limit: number

Number of results requested.

Optional Readonly meta

meta?: any

Readonly offset

offset: number

Number of elements skipped.

Readonly results

results: BaseResource[]

Optional Readonly total

total?: number

Total number of results matching the query. This number is an estimation that is not strongly consistent. This field is returned by default. For improved performance, calculating this field can be deactivated by using the query parameter withTotal=false. When the results are filtered with a Query Predicate, total is subject to a limit.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc