Interface IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>

Interface responsible for defining how the key and corresponding load values behave in the data manager, cache adapter, and database adapter during entity field loading.

interface IEntityLoadKey<
    TFields extends Record<string, any>,
    TIDField extends keyof TFields,
    TSerializedLoadValue,
    TLoadValue extends IEntityLoadValue<TSerializedLoadValue>,
> {
    createCacheKeyPartsForLoadValue(
        entityConfiguration: EntityConfiguration<TFields, TIDField>,
        value: TLoadValue,
    ): readonly string[];
    deserializeLoadValue(value: TSerializedLoadValue): TLoadValue;
    getDatabaseColumns(
        entityConfiguration: EntityConfiguration<TFields, TIDField>,
    ): readonly string[];
    getDatabaseValues(value: TLoadValue): readonly any[];
    getDataManagerDataLoaderKey(): string;
    getLoadMethodType(): EntityLoadMethodType;
    getLoadValueForObject(object: Readonly<TFields>): null | TLoadValue;
    isCacheable(
        entityConfiguration: EntityConfiguration<TFields, TIDField>,
    ): boolean;
    serializeLoadValue(value: TLoadValue): TSerializedLoadValue;
    toString(): string;
    validateRuntimeLoadValuesForDataManagerDataLoader(
        values: readonly TLoadValue[],
        entityClassName: string,
    ): void;
    vendNewLoadValueMap<V>(): LoadValueMap<TSerializedLoadValue, TLoadValue, V>;
}

Type Parameters

TFields extends Record<string, any>
TIDField extends keyof TFields
TSerializedLoadValue
TLoadValue extends IEntityLoadValue<TSerializedLoadValue>

Implemented by

Index

Methods

createCacheKeyPartsForLoadValue deserializeLoadValue getDatabaseColumns getDatabaseValues getDataManagerDataLoaderKey getLoadMethodType getLoadValueForObject isCacheable serializeLoadValue toString validateRuntimeLoadValuesForDataManagerDataLoader vendNewLoadValueMap

Methods

createCacheKeyPartsForLoadValue

createCacheKeyPartsForLoadValue(
entityConfiguration: EntityConfiguration<TFields, TIDField>,
value: TLoadValue,
): readonly string[]
Creates cache key parts for this key and a load value given an entity configuration. These parts will be included as part of the cache key.
Parameters
- entityConfiguration: EntityConfiguration<TFields, TIDField>
  The entity configuration used to derive cache key parts.
- value: TLoadValue
  The load value for which to create cache key parts for.
Returns readonly string[]
An object containing the cache key type and parts.
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:54

deserializeLoadValue

deserializeLoadValue(value: TSerializedLoadValue): TLoadValue
Deserialize a load value for use in the data manager data loader as the dataloader value key.
Parameters
- value: TSerializedLoadValue
Returns TLoadValue
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:78

getDatabaseColumns

getDatabaseColumns(
entityConfiguration: EntityConfiguration<TFields, TIDField>,
): readonly string[]
Get the database columns for this key given an entity configuration.
Parameters
- entityConfiguration: EntityConfiguration<TFields, TIDField>
  The entity configuration.
Returns readonly string[]
An array of database column names.
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:97

getDatabaseValues

getDatabaseValues(value: TLoadValue): readonly any[]
Get the database values corresponding to the database columns for this key for a load value.
Parameters
- value: TLoadValue
  The load value.
Returns readonly any[]
An array of database values.
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:107

getDataManagerDataLoaderKey

getDataManagerDataLoaderKey(): string
Gets the data loader key for this key. For single field keys, this is the field name. For composite keys, this is a unique identifier for the composite key.

Returns string
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:68

getLoadMethodType

getLoadMethodType(): EntityLoadMethodType
Gets the load method type of this key. Used as part of cache keys and data loader keys.

Returns EntityLoadMethodType
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:62

getLoadValueForObject

getLoadValueForObject(object: Readonly<TFields>): null | TLoadValue
Get the load value for an entity fields object from the database.
Parameters
- object: Readonly<TFields>
  The entity fields object.
Returns null | TLoadValue
The load value for the object or null if the load value would be invalid for the object (for example, if the value is null).
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:115

isCacheable

isCacheable(
entityConfiguration: EntityConfiguration<TFields, TIDField>,
): boolean
Determines if this key is cacheable in cache adapters according to the entity configuration.
Parameters
- entityConfiguration: EntityConfiguration<TFields, TIDField>
  The entity configuration to check.
Returns boolean
Boolean indicating whether this key is cacheable.
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:44

serializeLoadValue

serializeLoadValue(value: TLoadValue): TSerializedLoadValue
Serialize a load value for use in the data manager data loader as the dataloader value key.
Parameters
- value: TLoadValue
Returns TSerializedLoadValue
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:73

toString

toString(): string
Returns string
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:29

validateRuntimeLoadValuesForDataManagerDataLoader

validateRuntimeLoadValuesForDataManagerDataLoader(
values: readonly TLoadValue[],
entityClassName: string,
): void
Validate that that the load values adhere to the typescript types at runtime in order to prevent inadvertently passing invalid values to the data loader, cache adapter, or database adapter.
Parameters
- values: readonly TLoadValue[]
  The load values to validate.
- entityClassName: string
  The name of the entity class to which the load values belong (for error message only).
Returns void
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:86

vendNewLoadValueMap

vendNewLoadValueMap<V>(): LoadValueMap<TSerializedLoadValue, TLoadValue, V>
Vends a new empty load value map with a key type corresponding to the load value type of this load key.
Type Parameters
- V
Returns LoadValueMap<TSerializedLoadValue, TLoadValue, V>
A new empty load value map.
- Defined in packages/entity/src/internal/EntityLoadInterfaces.ts:36

Interface IEntityLoadKey<TFields, TIDField, TSerializedLoadValue, TLoadValue>

Type Parameters

Implemented by

Index

Methods

Methods

createCacheKeyPartsForLoadValue

Parameters

Returns readonly string[]

deserializeLoadValue

Parameters

Returns TLoadValue

getDatabaseColumns

Parameters

Returns readonly string[]

getDatabaseValues

Parameters

Returns readonly any[]

getDataManagerDataLoaderKey

Returns string

getLoadMethodType

Returns EntityLoadMethodType

getLoadValueForObject

Parameters

Returns null | TLoadValue

isCacheable

Parameters

Returns boolean

serializeLoadValue

Parameters

Returns TSerializedLoadValue

toString

Returns string

validateRuntimeLoadValuesForDataManagerDataLoader

Parameters

Returns void

vendNewLoadValueMap

Type Parameters

Returns LoadValueMap<TSerializedLoadValue, TLoadValue, V>

Settings

On This Page