Class EntityConfiguration<TFields>

constructor

• new EntityConfiguration<TFields>(__namedParameters): EntityConfiguration<TFields>

• Type Parameters

  • TFields

  Parameters

  • __namedParameters: {
        cacheAdapterFlavor: string;
        cacheKeyVersion?: number;
        databaseAdapterFlavor: string;
        idField: keyof TFields;
        inboundEdges?: IEntityClass<any, any, any, any, any, any>[];
        schema: Record<keyof TFields, EntityFieldDefinition<any>>;
        tableName: string;
    }

    • cacheAdapterFlavor: string

      Cache system for this entity.

    • Optional cacheKeyVersion?: number

      Cache key version for this entity type. Should be bumped when a field is added to, removed from, or changed in this entity and the underlying database table.

    • databaseAdapterFlavor: string

      Backing database and transaction type for this entity.

    • idField: keyof TFields

      The field used to identify this entity. Must be a unique field in the table.

    • Optional inboundEdges?: IEntityClass<any, any, any, any, any, any>[]

      List of other entity types that reference this type in EntityFieldDefinition associations.

    • schema: Record<keyof TFields, EntityFieldDefinition<any>>

      Map from each entity field to an EntityFieldDefinition specifying information about the field.

    • tableName: string

      The name of the table where entities of this type are stored.

  Returns EntityConfiguration<TFields>

Readonly cacheAdapterFlavor

Readonly cacheKeyVersion

Readonly cacheableKeys

Readonly databaseAdapterFlavor

Readonly dbToEntityFieldsKeyMapping

Readonly entityToDBFieldsKeyMapping

Readonly idField

Readonly inboundEdges

Readonly schema

Readonly tableName