• Type Parameters

    • Item
    • Additional
    • Error

    Parameters

    • params: Readonly<{
          additional?: Additional;
          alwaysResetFilters?: Readonly<Record<string, unknown>>;
          appliedFilters?: Readonly<Record<string, unknown>>;
          autoload?: boolean;
          createDataStore?: ((initalValue: Readonly<{
              appliedFilters: Record<string, unknown>;
              page: number;
              pageSize?: null | number;
              sort: Readonly<{
                  asc: boolean;
                  param?: null | string;
              }>;
          }>) => DataStore);
          debounceTimeout?: number;
          isDefaultSortAsc?: boolean;
          items?: readonly Item[];
          loadItems: ItemsLoader<Item, Additional, Error>;
          page?: null | number;
          pageSize?: null | number;
          refreshTimeout?: number;
          resetFiltersTo?: Readonly<Record<string, unknown>>;
          saveFiltersOnResetAll?: readonly string[];
          saveItemsWhileLoad?: boolean;
          shouldRefresh?: (() => boolean);
          sort?: Readonly<{
              asc: boolean;
              param?: null | string;
          }>;
          total?: null | number;
      }>

    Returns Readonly<{
        alwaysResetFilters: Readonly<Record<string, unknown>>;
        autoload: boolean;
        debounceTimeout?: number;
        isDefaultSortAsc: boolean;
        refreshTimeout?: number;
        resetFiltersTo: Readonly<Record<string, unknown>>;
        saveFiltersOnResetAll: readonly string[];
        saveItemsWhileLoad: boolean;
    }>