Interface ConfigKeys<M, HashKey, RangeKey, T>Protected

Returns variably-optional properties of the Config type as optional.

interface ConfigKeys<M, HashKey, RangeKey, T> {
    entities?: ConfigEntities<M, HashKey, RangeKey, T>;
    hashKey?: ExclusiveKey<HashKey, M, RangeKey>;
    rangeKey?: ExclusiveKey<RangeKey, M, HashKey>;
}

Type Parameters

  • M extends EntityMap

    The EntityMap type that identitfies the Entity & related property types to be managed by EntityManager.

  • HashKey extends string

    The property used across the configuration to store an Entity's sharded hash key. Should be configured as the table hash key. Must not conflict with any Entity property.

  • RangeKey extends string

    The property used across the configuration to store an Entity's range key. Should be configured as the table range key. Must not conflict with any Entity property.

  • T extends TranscodeMap

    The TranscodeMap identifying transcodable property types. Only Entity properties of these types can be components of an index or a generated property.

Entity Manager

entities? rangeKey?

Config

hashKey?

Entity Manager

Optionalentities

entities?: ConfigEntities<M, HashKey, RangeKey, T>

Defines options for each Entity in the Config EntityMap type parameter.

The properties of this object must exactly match the keys of the Config EntityMap type parameter.

OptionalrangeKey

rangeKey?: ExclusiveKey<RangeKey, M, HashKey>

The property used across the configuration to store an Entity's range key. Should be configured as the table range key.

This value must exactly match the Config RangeKey type parameter, and must not conflict with any Entity property.

Default Value

'rangeKey'

Config

Protected OptionalhashKey

hashKey?: ExclusiveKey<HashKey, M, RangeKey>

The property used across the configuration to store an Entity's sharded hash key. Should be configured as the table hash key.

This value must exactly match the Config HashKey type parameter, and must not conflict with any Entity property.

Default Value

'hashKey'

Settings

Member Visibility

On This Page

Entity Manager
Config