Interface EntityDef<Name, Schema, Methods>

Entity definition returned by defineEntity(...).build().

interface EntityDef<
    Name extends string,
    Schema extends StandardSchema,
    Methods extends AnyMethods,
> {
    name: Name;
    schema: Schema;
    Type: EntityInstance<Name, Schema, Methods>;
    create(
        props: InferOutput<Schema>,
    ):
        | EntityInstance<Name, Schema, Methods>
        | Promise<EntityInstance<Name, Schema, Methods>>;
    fromJSON(
        json: InferOutput<Schema>,
    ):
        | EntityInstance<Name, Schema, Methods>
        | Promise<EntityInstance<Name, Schema, Methods>>;
}

Type Parameters

Name extends string
Schema extends StandardSchema
Methods extends AnyMethods

Index

Properties

name schema Type

Methods

create fromJSON

Properties

name

name: Name

Name used for debugging and introspection.

schema

schema: Schema

Standard Schema used to validate entity props.

Type

Type: EntityInstance<Name, Schema, Methods>

Type-only alias for the entity instance type. Undefined at runtime.

Methods

create

create(
    props: InferOutput<Schema>,
):
    | EntityInstance<Name, Schema, Methods>
    | Promise<EntityInstance<Name, Schema, Methods>>
Create a new frozen entity instance from props.

Returns a promise when the underlying Standard Schema validates async.
Parameters
- props: InferOutput<Schema>
Returns
| EntityInstance<Name, Schema, Methods>
| Promise<EntityInstance<Name, Schema, Methods>>
- Defined in packages/core/src/domain/entity.ts:109

fromJSON

fromJSON(
    json: InferOutput<Schema>,
):
    | EntityInstance<Name, Schema, Methods>
    | Promise<EntityInstance<Name, Schema, Methods>>
Reconstruct an entity instance from JSON, usually from persistence.
Parameters
- json: InferOutput<Schema>
Returns
| EntityInstance<Name, Schema, Methods>
| Promise<EntityInstance<Name, Schema, Methods>>
- Defined in packages/core/src/domain/entity.ts:117