Entity

    Module @expo/entity

    @expo/entity

    Documentation

    A instance of an entity represents a single "row" (object) of persisted data in a database that a viewer, represented by a ViewerContext, has permission to read.

    Authorization of create, read, update, and delete operations for an entity are declaratively defined using an EntityPrivacyPolicy.

    Entites are loaded through an EntityLoader, which is responsible for orchestrating fetching, caching, and authorization of entity loads.

    Entities are mutated and deleted through an EntityMutator, which is responsible for orchestrating database writes, cache invalidation, and authorization of entity mutations.

    Enumerations

    CacheStatus
    EntityAuthorizationAction
    EntityEdgeDeletionAuthorizationInferenceBehavior
    EntityEdgeDeletionBehavior
    EntityErrorCode
    EntityErrorState
    EntityLoadMethodType
    EntityMetricsAuthorizationResult
    EntityMetricsLoadType
    EntityMetricsMutationType
    EntityMutationType
    EntityPrivacyPolicyEvaluationMode
    IncrementLoadCountEventType
    OrderByOrdering
    RuleEvaluationResult
    TransactionIsolationLevel

    Classes

    AlwaysAllowPrivacyPolicyRule
    AlwaysDenyPrivacyPolicyRule
    AlwaysSkipPrivacyPolicyRule
    AuthorizationResultBasedCreateMutator
    AuthorizationResultBasedDeleteMutator
    AuthorizationResultBasedEntityAssociationLoader
    AuthorizationResultBasedEntityLoader
    AuthorizationResultBasedUpdateMutator
    BooleanField
    ComposedEntityCacheAdapter
    ComposedSecondaryEntityCache
    CompositeFieldHolder
    CompositeFieldInfo
    CompositeFieldValueHolder
    CompositeFieldValueHolderMap
    CompositeFieldValueMap
    DateField
    EnforcingEntityAssociationLoader
    EnforcingEntityCreator
    EnforcingEntityDeleter
    EnforcingEntityLoader
    EnforcingEntityUpdater
    Entity
    EntityAssociationLoader
    EntityCacheAdapterError
    EntityCacheAdapterTransientError
    EntityCompanion
    EntityCompanionProvider
    EntityConfiguration
    EntityCreator
    EntityDatabaseAdapter
    EntityDatabaseAdapterCheckConstraintError
    EntityDatabaseAdapterError
    EntityDatabaseAdapterExclusionConstraintError
    EntityDatabaseAdapterForeignKeyConstraintError
    EntityDatabaseAdapterNotNullConstraintError
    EntityDatabaseAdapterTransientError
    EntityDatabaseAdapterUniqueConstraintError
    EntityDatabaseAdapterUnknownError
    EntityDataManager
    EntityDeleter
    EntityError
    EntityFieldDefinition
    EntityInvalidFieldValueError
    EntityLoader
    EntityLoaderFactory
    EntityLoaderUtils
    EntityMutationTrigger
    EntityMutationValidator
    EntityMutatorFactory
    EntityNestedTransactionalQueryContext
    EntityNonTransactionalMutationTrigger
    EntityNonTransactionalQueryContext
    EntityNotAuthorizedError
    EntityNotFoundError
    EntityPrivacyPolicy
    EntityQueryContext
    EntityQueryContextProvider
    EntitySecondaryCacheLoader
    EntityTableDataCoordinator
    EntityTransactionalQueryContext
    EntityUpdater
    EnumField
    FloatField
    GenericEntityCacheAdapter
    GenericSecondaryEntityCache
    IntField
    JSONObjectField
    LoadValueMap
    NoOpEntityMetricsAdapter
    PrivacyPolicyRule
    ReadonlyEntity
    ReadThroughEntityCache
    SerializableKeyMap
    SingleFieldHolder
    SingleFieldValueHolder
    SingleFieldValueHolderMap
    StrictEnumField
    StringArrayField
    StringField
    UUIDField
    ViewerContext
    ViewerScopedEntityCompanion
    ViewerScopedEntityCompanionProvider
    ViewerScopedEntityLoaderFactory
    ViewerScopedEntityMutatorFactory

    Interfaces

    CacheAdapterFlavorDefinition
    DatabaseAdapterFlavorDefinition
    EntityAssociationDefinition
    EntityCompanionDefinition
    EntityFieldDefinitionOptions
    EntityFieldDefinitionOptionsBase
    EntityFieldDefinitionOptionsExplicitCache
    EntityLoadThroughDirective
    EntityMetricsAuthorizationEvent
    EntityMetricsLoadEvent
    EntityMetricsMutationEvent
    EntityMutationTriggerConfiguration
    FieldTransformer
    IEntityCacheAdapter
    IEntityCacheAdapterProvider
    IEntityClass
    IEntityDatabaseAdapterProvider
    IEntityGenericCacher
    IEntityLoadKey
    IEntityLoadValue
    IEntityMetricsAdapter
    IncrementLoadCountEvent
    IPrivacyPolicyClass
    ISecondaryEntityCache
    ISerializable
    MultiValueFieldEqualityCondition
    QuerySelectionModifiers
    QuerySelectionModifiersWithOrderByRaw
    SingleValueFieldEqualityCondition
    TableFieldMultiValueEqualityCondition
    TableFieldSingleValueEqualityCondition
    TableQuerySelectionModifiers
    TableQuerySelectionModifiersWithOrderByRaw

    Type Aliases

    CacheAdapterFlavor
    CacheLoadResult
    DatabaseAdapterFlavor
    EntityCascadingDeletionInfo
    EntityCompositeField
    EntityCompositeFieldDefinition
    EntityCompositeFieldValue
    EntityPrivacyEvaluationResult
    EntityPrivacyEvaluationResultFailure
    EntityPrivacyEvaluationResultSuccess
    EntityPrivacyPolicyEvaluationContext
    EntityPrivacyPolicyEvaluator
    EntityTriggerMutationInfo
    EntityValidatorMutationInfo
    FieldEqualityCondition
    FieldTransformerMap
    LoadPair
    PartitionArrayPredicate
    PostCommitCallback
    PreCommitCallback
    SerializedCompositeFieldHolder
    SerializedCompositeFieldValueHolder
    TransactionConfig

    Functions

    areSetsEqual
    canViewerDeleteAsync
    canViewerUpdateAsync
    computeIfAbsent
    enforceResultsAsync
    failedResults
    failedResultsFilterMap
    filterMap
    getCanViewerDeleteResultAsync
    getCanViewerUpdateResultAsync
    getDatabaseFieldForEntityField
    invertMap
    isSingleValueFieldEqualityCondition
    mapKeys
    mapMap
    mapMapAsync
    mergeEntityMutationTriggerConfigurations
    partitionArray
    partitionErrors
    pick
    reduceMap
    reduceMapAsync
    successfulResults
    successfulResultsFilterMap
    timeAndLogLoadEventAsync
    timeAndLogLoadMapEventAsync
    timeAndLogMutationEventAsync
    transformCacheObjectToFields
    transformDatabaseObjectToFields
    transformFieldsToCacheObject
    transformFieldsToDatabaseObject
    zipToMap
    MMNEPVFCICPMFPCPTTAAATR