readField
Call Signature
Section titled “Call Signature”readField<
T,K>(entity,trait,field):TraitRecord<T>[K] |undefined
field of entity’s trait, as entity.get(trait)?.[field] reads
it, building no record: get copies every field of a trait of fields
into a new one. Undefined where the entity lacks the trait.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
T extends Trait |
K extends string | number | symbol |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
entity |
Entity |
trait |
T |
field |
K |
Returns
Section titled “Returns”TraitRecord<T>[K] | undefined
Call Signature
Section titled “Call Signature”readField<
S,K>(entity,predicted,field):DeepReadonly<TraitRecord<S>[K]> |undefined
As readField of koota’s trait, of a predicted trait, read-only.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
S extends Schema |
K extends string | number | symbol |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
entity |
Entity |
predicted |
PredictedTrait<S> |
field |
K |
Returns
Section titled “Returns”DeepReadonly<TraitRecord<S>[K]> | undefined