Beignet API reference
    Preparing search index...

    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>>;
    } & {
        [K in keyof Methods]: Methods[K] extends (...args: infer A) => infer R
            ? (
                ...args: A,
            ) => WithEntityInstance<R, EntityInstance<Name, Schema, Methods>, Schema>
            : Methods[K]
    }

    Entity instance with validated props, attached methods, and immutable update helpers. Method returns that are typed as the base instance (self or self.with(...)) are mapped to the full instance type so chaining keeps the entity's methods.

    Type Parameters

    • Name extends string
    • Schema extends StandardSchema
    • Methods extends AnyMethods

    Type Declaration

    Settings
    Member Visibility