Type Alias ConfigMap<M>

ConfigMap<M>: ValidateConfigMap<{
    EntityMap: "EntityMap" extends keyof M
        ? NonNullable<M["EntityMap"]>
        : Record<string, never>;
    HashKey: "HashKey" extends keyof M
        ? NonNullable<M["HashKey"]>
        : "hashKey";
    RangeKey: "RangeKey" extends keyof M
        ? NonNullable<M["RangeKey"]>
        : "rangeKey";
    ShardedKeys: "ShardedKeys" extends keyof M
        ? NonNullable<M["ShardedKeys"]>
        : never;
    TranscodedProperties: "TranscodedProperties" extends keyof M
        ? NonNullable<M["TranscodedProperties"]>
        : never;
    TranscodeMap: "TranscodeMap" extends keyof M
        ? NonNullable<M["TranscodeMap"]>
        : DefaultTranscodeMap;
    UnshardedKeys: "UnshardedKeys" extends keyof M
        ? NonNullable<M["UnshardedKeys"]>
        : never;
}>

Generates & validates the map defining defines an EntityManager configuration's EntityMap, key properties, and TranscodeMap.

Unspecified properties will default to those defined in BaseConfigMap.

Type Parameters

M extends Partial<BaseConfigMap> = Partial<BaseConfigMap>
BaseConfigMap extension. If omitted, defaults to BaseConfigMap.

Type Alias ConfigMap<M>

Type Parameters

Settings