@reduxjs/toolkit/src/entities/create_adapter.ts

The official, opinionated, batteries-included toolset for efficient Redux development

import type {
  EntityDefinition,
  Comparer,
  IdSelector,
  EntityAdapter,
  EntityId,
} from './models'
import { createInitialStateFactory } from './entity_state'
import { createSelectorsFactory } from './state_selectors'
import { createSortedStateAdapter } from './sorted_state_adapter'
import { createUnsortedStateAdapter } from './unsorted_state_adapter'

export interface EntityAdapterOptions<T, Id extends EntityId> {
  selectId?: IdSelector<T, Id>
  sortComparer?: false | Comparer<T>
}

export function createEntityAdapter<T, Id extends EntityId>(options: {
  selectId: IdSelector<T, Id>
  sortComparer?: false | Comparer<T>
}): EntityAdapter<T, Id>

export function createEntityAdapter<T extends { id: EntityId }>(options?: {
  sortComparer?: false | Comparer<T>
}): EntityAdapter<T, T['id']>

/**
 *
 * @param options
 *
 * @public
 */
export function createEntityAdapter<T>(
  options: {
    selectId?: IdSelector<T, EntityId>
    sortComparer?: false | Comparer<T>
  } = {}
): EntityAdapter<T, EntityId> {
  const { selectId, sortComparer }: EntityDefinition<T, EntityId> = {
    sortComparer: false,
    selectId: (instance: any) => instance.id,
    ...options,
  }

  const stateFactory = createInitialStateFactory<T, EntityId>()
  const selectorsFactory = createSelectorsFactory<T, EntityId>()
  const stateAdapter = sortComparer
    ? createSortedStateAdapter(selectId, sortComparer)
    : createUnsortedStateAdapter(selectId)

  return {
    selectId,
    sortComparer,
    ...stateFactory,
    ...selectorsFactory,
    ...stateAdapter,
  }
}