GitHub

DaffCollectionMemoizedSelectors

An interface to describe all selectors related to the collection metadata.

import { DaffCollectionMemoizedSelectors } from '@daffodil/core/state'
interface DaffCollectionMemoizedSelectors<TState, TMetadata extends DaffCollectionMetadata = DaffCollectionMetadata> {
  selectCollectionMetadata: MemoizedSelector<TState, TMetadata>
  selectCollectionRequest: MemoizedSelector<TState, DaffCollectionRequest>
  selectCollectionCount: MemoizedSelector<TState, TMetadata['count']>
  selectCollectionCurrentPage: MemoizedSelector<TState, TMetadata['currentPage']>
  selectCollectionTotalPages: MemoizedSelector<TState, TMetadata['totalPages']>
  selectCollectionPageSize: MemoizedSelector<TState, TMetadata['pageSize']>
  selectCollectionSortOptions: MemoizedSelector<TState, TMetadata['sortOptions']['options']>
  selectCollectionAppliedSortOption: MemoizedSelector<TState, TMetadata['appliedSortOption']>
  selectCollectionAppliedSortDirection: MemoizedSelector<TState, TMetadata['appliedSortDirection']>
  selectCollectionIds: MemoizedSelector<TState, TMetadata['ids']>
  selectCollectionFilters: MemoizedSelector<TState, TMetadata['filters']>
  selectCollectionAppliedFilters: MemoizedSelector<TState, DaffFilters>
}

Properties

Name Type Description
selectCollectionMetadata MemoizedSelector<TState, TMetadata>

Selects the metadata for the collection.

selectCollectionRequest MemoizedSelector<TState, DaffCollectionRequest>

Builds a request that matches the current collection.

selectCollectionCount MemoizedSelector<TState, TMetadata['count']>

Selects the total number of items of the collection.

selectCollectionCurrentPage MemoizedSelector<TState, TMetadata['currentPage']>

Selects the current page of items of the collection.

selectCollectionTotalPages MemoizedSelector<TState, TMetadata['totalPages']>

Selects the total number of pages of items that exist in the collection.

selectCollectionPageSize MemoizedSelector<TState, TMetadata['pageSize']>

Selects the number of items on each collection.

selectCollectionSortOptions MemoizedSelector<TState, TMetadata['sortOptions']['options']>

Selects the sort options that may be applied to the collection.

selectCollectionAppliedSortOption MemoizedSelector<TState, TMetadata['appliedSortOption']>

Selects the applied sorting option if one is applied.

selectCollectionAppliedSortDirection MemoizedSelector<TState, TMetadata['appliedSortDirection']>

Selects the applied sorting direction if a sorting option is applied.

selectCollectionIds MemoizedSelector<TState, TMetadata['ids']>

Selects the applied sorting direction if a sorting option is applied.

selectCollectionFilters MemoizedSelector<TState, TMetadata['filters']>

Selects the filters that may be applied to the collection.

selectCollectionAppliedFilters MemoizedSelector<TState, DaffFilters>

Returns a dict of filters and only their applied options. Filters with no applied options will be omitted.