DaffCollectionFacadeInterface

import { DaffCollectionFacadeInterface } from '@daffodil/core/state'

A facade for interacting with a collection state.

interface DaffCollectionFacadeInterface<TMetadata extends DaffCollectionMetadata = DaffCollectionMetadata> {
  metadata$: Observable<TMetadata>
  request$: Observable<DaffCollectionRequest>
  count$: Observable<number>
  currentPage$: Observable<number>
  totalPages$: Observable<number>
  pageSize$: Observable<number>
  sortOptions$: Observable<DaffSortOption[]>
  appliedSortOption$: Observable<string>
  appliedSortDirection$: Observable<DaffSortDirectionEnum>
  filters$: Observable<DaffFilters>
  appliedFilters$: Observable<DaffFilters>
}

Properties

metadata$ `Observable<TMetadata>`
The page metadata for the collection.

request$ `Observable<DaffCollectionRequest>`
Builds a request that matches the current collection.

count$ `Observable<number>`
The number of items in the collection.

currentPage$ `Observable<number>`
The current page of items for the collection.

totalPages$ `Observable<number>`
The number of pages of items available in the collection.

pageSize$ `Observable<number>`
The number of items per page for the collection.

sortOptions$ `Observable<DaffSortOption[]>`
The sort options available for the items of the collection.

appliedSortOption$ `Observable<string>`
The sort options available for the items of the collection.

appliedSortDirection$ `Observable<DaffSortDirectionEnum>`
The sort options available for the items of the collection.

filters$ `Observable<DaffFilters>`
The filters available for the entities of the collection.

appliedFilters$ `Observable<DaffFilters>`
The sort options available for the entities of the collection.