The property in the raw data used for the Entity's ID.
Optional function to supply the model type to construct, given the raw data. Useful for APIs that can return multiple entity types, with a common discriminator to differentiate them.
Human-readable name for the Entity type, plural. e.g 'Users', 'To do items', 'Movies', 'Comments', etc. Used internally for error messages, for example, or can be used in reflection.
If readonly is set to true
, all models of this entity type will be immutable - frozen with Object.freeze.
Readonly models don't have a $parent property.
Human-readable name for the Entity type, singular. e.g 'User', 'To do item', 'Movie', 'Comment', etc. Used internally for error messages, for example, or can be used in reflection.
Hard-coded items for this Entity. When values are specified, no endpoint is required, and items are always returned from these values, instead of backend.
Hard-coding values for an Entity:
Generated using TypeDoc
Tests whether the entity contains a hard-coded value with the specified ID (in the entities
values
configuration).