GitHub

DaffCollectionRequest

A collection of items that is paginable, sortable, and filterable.

import { DaffCollectionRequest } from '@daffodil/core'
interface DaffCollectionRequest {
  appliedSortOption: string
  appliedSortDirection: DaffSortDirectionEnum
  currentPage: number
  pageSize: number
  filterRequests: DaffFilterRequest[]
}

Properties

Name Type Description
appliedSortOption string

The option by which to sort the collection's items.

appliedSortDirection DaffSortDirectionEnum

The direction by which to sort the collection's items.

currentPage number

What page of the collection's items to retrieve.

pageSize number

The number of items per-page to request.

filterRequests DaffFilterRequest[]

The properties by which to filter the items of the collection being requested.