Class CompositeFieldHolder<TFields, TIDField>

constructor

• new CompositeFieldHolder<
      TFields extends Record<string, any>,
      TIDField extends string | number | symbol,
  >(
      compositeFieldInput: EntityCompositeField<TFields>,
  ): CompositeFieldHolder<TFields, TIDField>

  Type Parameters

  • TFields extends Record<string, any>
  • TIDField extends string | number | symbol

  Parameters

  • compositeFieldInput: EntityCompositeField<TFields>

  Returns CompositeFieldHolder<TFields, TIDField>

ReadonlycompositeField

createCacheKeyPartsForLoadValue

• createCacheKeyPartsForLoadValue(
      entityConfiguration: EntityConfiguration<TFields, TIDField>,
      value: CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>,
  ): 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: CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

    The load value for which to create cache key parts for.

  Returns readonly string[]

  An object containing the cache key type and parts.

deserializeLoadValue

• deserializeLoadValue(
      value: SerializedCompositeFieldValueHolder,
  ): CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

  Deserialize a load value for use in the data manager data loader as the dataloader value key.

  Parameters

  • value: SerializedCompositeFieldValueHolder

  Returns CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

extractCompositeFieldValueHolderFromObjectFields

• extractCompositeFieldValueHolderFromObjectFields(
      objectFields: TFields,
  ): null | CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

  Parameters

  • objectFields: TFields

  Returns null | CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

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.

getDatabaseValues

• getDatabaseValues(
      value: CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>,
  ): readonly any[]

  Get the database values corresponding to the database columns for this key for a load value.

  Parameters

  • value: CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

    The load value.

  Returns readonly any[]

  An array of database values.

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

getFieldSet

• getFieldSet(): ReadonlySet<keyof TFields>

  Returns ReadonlySet<keyof TFields>

getLoadMethodType

• getLoadMethodType(): EntityLoadMethodType

  Gets the load method type of this key. Used as part of cache keys and data loader keys.

  Returns EntityLoadMethodType

getLoadValueForObject

• getLoadValueForObject(
      object: Readonly<TFields>,
  ): null | CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

  Get the load value for an entity fields object from the database.

  Parameters

  • object: Readonly<TFields>

    The entity fields object.

  Returns null | CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

  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).

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.

serialize

• serialize(): SerializedCompositeFieldHolder

  Returns SerializedCompositeFieldHolder

serializeLoadValue

• serializeLoadValue(
      value: CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>,
  ): SerializedCompositeFieldValueHolder

  Serialize a load value for use in the data manager data loader as the dataloader value key.

  Parameters

  • value: CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>

  Returns SerializedCompositeFieldValueHolder

toString

• toString(): string

  Returns string

validateRuntimeLoadValuesForDataManagerDataLoader

• validateRuntimeLoadValuesForDataManagerDataLoader(
      values: readonly CompositeFieldValueHolder<
          TFields,
          EntityCompositeField<TFields>,
      >[],
      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 CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>[]

    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

vendNewLoadValueMap

• vendNewLoadValueMap<V>(): LoadValueMap<
      SerializedCompositeFieldValueHolder,
      CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>,
      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<
      SerializedCompositeFieldValueHolder,
      CompositeFieldValueHolder<TFields, EntityCompositeField<TFields>>,
      V,
  >

  A new empty load value map.