Skip to main content

Type Alias: EntityResourceResult<Entity>

EntityResourceResult<Entity> = object

Defined in: lib/with-entity-resources.ts:241

Internal

Description​

Type composition notes: we intentionally do not duplicate or re-declare types that already exist in @ngrx/signals/entities or in this library's with-resource feature. Instead, we compose the resulting API via intersections of those public contracts.

Rationale:

  • Keeps our types in sync with upstream sources and avoids drift.
  • Reduces maintenance overhead and duplication.
  • Ensures consumers benefit automatically from upstream typing fixes.

Concretely:

  • For unnamed resources we return ResourceResult<Entity> intersected with EntityState<Entity> and EntityProps<Entity>.
  • For named resources we return NamedResourceResult<T> intersected with NamedEntityState<E, Name> and NamedEntityProps<E, Name> for each entry.

Type Parameters​

Entity​

Entity

Properties​

methods​

methods: ResourceResult<Entity>["methods"]

Defined in: lib/with-entity-resources.ts:244

props​

props: ResourceResult<Entity>["props"] & EntityProps<Entity>

Defined in: lib/with-entity-resources.ts:243

state​

state: ResourceResult<Entity>["state"] & EntityState<Entity>

Defined in: lib/with-entity-resources.ts:242