Class CompositeFieldInfo<TFields, TIDField>

Helper class to validate and store composite field information.

Type Parameters

TFields extends Record<string, any>
TIDField extends keyof TFields

Index

Constructors

Methods

canCacheCompositeField getAllCompositeFieldHolders getCompositeFieldHolderForCompositeField

Constructors

constructor

new CompositeFieldInfo<
    TFields extends Record<string, any>,
    TIDField extends string | number | symbol,
>(
    compositeFieldsDefinitions: EntityCompositeFieldDefinition<TFields>[],
): CompositeFieldInfo<TFields, TIDField>
Type Parameters
- TFields extends Record<string, any>
- TIDField extends string | number | symbol
Parameters
- compositeFieldsDefinitions: EntityCompositeFieldDefinition<TFields>[]
Returns CompositeFieldInfo<TFields, TIDField>
- Defined in packages/entity/src/EntityConfiguration.ts:59

Methods

canCacheCompositeField

canCacheCompositeField(compositeField: EntityCompositeField<TFields>): boolean
Parameters
- compositeField: EntityCompositeField<TFields>
Returns boolean
- Defined in packages/entity/src/EntityConfiguration.ts:90

getAllCompositeFieldHolders

getAllCompositeFieldHolders(): readonly CompositeFieldHolder<TFields, TIDField>[]
Returns readonly CompositeFieldHolder<TFields, TIDField>[]
- Defined in packages/entity/src/EntityConfiguration.ts:86

getCompositeFieldHolderForCompositeField

getCompositeFieldHolderForCompositeField(
compositeField: EntityCompositeField<TFields>,
): undefined | CompositeFieldHolder<TFields, TIDField>
Parameters
- compositeField: EntityCompositeField<TFields>
Returns undefined | CompositeFieldHolder<TFields, TIDField>
- Defined in packages/entity/src/EntityConfiguration.ts:79