Interface: ResourcefulIndexResult<ReturnType>
Result object returned by the resourceful index/list operation.
Contains paginated records along with metadata about the query execution and pagination state. The records are filtered according to field-level access control and only contain the requested fields.
Type Parameters
| Type Parameter | Default type | Description |
|---|---|---|
ReturnType | any | The shape of records after field selection and ACL filtering |
Properties
| Property | Type | Description |
|---|---|---|
aggregations | ResourcefulIndexAggregateResults | Aggregation results organized by field name and operation type |
countQuery | string | SQL query string used for counting total records |
page | number | The current page number (1-based) |
perPage | number | Number of records per page |
records | Partial<ReturnType>[] | Array of records with only the requested and accessible fields |
recordsQuery | string | SQL query string used for fetching the paginated records |
total | number | Total number of records matching the filter (before pagination) |