tweak types

Author: EskiMojo14

packages/toolkit/src/entities/create_adapter.ts

@@ -1,28 +1,17 @@
-import type {
-  EntityDefinition,
-  Comparer,
-  IdSelector,
-  EntityAdapter,
-  EntityId,
-} from './models'
+import type { EntityAdapter, EntityId, EntityAdapterOptions } from './models'
 import { createInitialStateFactory } from './entity_state'
 import { createSelectorsFactory } from './state_selectors'
 import { createSortedStateAdapter } from './sorted_state_adapter'
 import { createUnsortedStateAdapter } from './unsorted_state_adapter'
+import type { WithRequiredProp } from '../tsHelpers'
 
-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, Id extends EntityId>(
+  options: WithRequiredProp<EntityAdapterOptions<T, Id>, 'selectId'>,
+): EntityAdapter<T, Id>
 
-export function createEntityAdapter<T extends { id: EntityId }>(options?: {
-  sortComparer?: false | Comparer<T>
-}): EntityAdapter<T, T['id']>
+export function createEntityAdapter<T extends { id: EntityId }>(
+  options?: Omit<EntityAdapterOptions<T, T['id']>, 'selectId'>,
+): EntityAdapter<T, T['id']>
 
 /**
  *
@@ -31,12 +20,12 @@ export function createEntityAdapter<T extends { id: EntityId }>(options?: {
  * @public
  */
 export function createEntityAdapter<T>(
-  options: {
-    selectId?: IdSelector<T, EntityId>
-    sortComparer?: false | Comparer<T>
-  } = {},
+  options: EntityAdapterOptions<T, EntityId> = {},
 ): EntityAdapter<T, EntityId> {
-  const { selectId, sortComparer }: EntityDefinition<T, EntityId> = {
+  const {
+    selectId,
+    sortComparer,
+  }: Required<EntityAdapterOptions<T, EntityId>> = {
     sortComparer: false,
     selectId: (instance: any) => instance.id,
     ...options,

packages/toolkit/src/entities/models.ts

@@ -35,9 +35,9 @@ export interface EntityState<T, Id extends EntityId> {
 /**
  * @public
  */
-export interface EntityDefinition<T, Id extends EntityId> {
-  selectId: IdSelector<T, Id>
-  sortComparer: false | Comparer<T>
+export interface EntityAdapterOptions<T, Id extends EntityId> {
+  selectId?: IdSelector<T, Id>
+  sortComparer?: false | Comparer<T>
 }
 
 export type PreventAny<S, T, Id extends EntityId> = CastAny<
@@ -166,6 +166,9 @@ export interface EntitySelectors<T, V, Id extends EntityId> {
   selectById: (state: V, id: Id) => Compute<UncheckedIndexedAccess<T>>
 }
 
+/**
+ * @public
+ */
 export interface EntityStateFactory<T, Id extends EntityId> {
   getInitialState(
     state?: undefined,
@@ -182,9 +185,8 @@ export interface EntityStateFactory<T, Id extends EntityId> {
  */
 export interface EntityAdapter<T, Id extends EntityId>
   extends EntityStateAdapter<T, Id>,
-    EntityStateFactory<T, Id> {
-  selectId: IdSelector<T, Id>
-  sortComparer: false | Comparer<T>
+    EntityStateFactory<T, Id>,
+    Required<EntityAdapterOptions<T, Id>> {
   getSelectors(
     selectState?: undefined,
     options?: GetSelectorsOptions,