Interface NexusEntity<E>

A "struct"/"object" like field in the document:

fields of entities that are objects are a NexusObject
NexusEntity inherits NexusObject

interface NexusEntity<E extends keyof EntityTypes = keyof EntityTypes> {
    entityType: E;
    fields: EntityTypes[E];
    id: string;
    location: NexusLocation;
}

Type Parameters

E extends keyof EntityTypes = keyof EntityTypes

Hierarchy (View Summary)

NexusObject<EntityTypes[E]>
- NexusEntity

Index

Properties

entityType fields id location

Properties

`Readonly`entityType

entityType: E

The entity type key of this entity.

fields

fields: EntityTypes[E]

the fields in this object

`Readonly`id

id: string

The id of this entity.

location

location: NexusLocation