Type Alias EntityInstance<Name, Schema, Methods>

EntityInstance: InferOutput<Schema> & {
    toJSON(): InferOutput<Schema>;
    with(
        patch: Partial<InferOutput<Schema>>,
    ):
        | EntityInstance<Name, Schema, Methods>
        | Promise<EntityInstance<Name, Schema, Methods>>;
} & Methods

Entity instance with validated props, attached methods, and immutable update helpers.

Type Parameters

Name extends string
Schema extends StandardSchema
Methods extends AnyMethods

Type Declaration

toJSON: function
- toJSON(): InferOutput<Schema>
  Convert the entity to a plain JSON object for persistence.
  
  Returns InferOutput<Schema>
  - Defined in packages/core/src/domain/entity.ts:89
with: function
- with(
      patch: Partial<InferOutput<Schema>>,
  ):
      | EntityInstance<Name, Schema, Methods>
      | Promise<EntityInstance<Name, Schema, Methods>>
  Create a new validated entity instance with patched properties.
  Parameters
  - patch: Partial<InferOutput<Schema>>
  Returns
  | EntityInstance<Name, Schema, Methods>
  | Promise<EntityInstance<Name, Schema, Methods>>
  - Defined in packages/core/src/domain/entity.ts:81