@karmaniverous/entity-manager
    Preparing search index...

    Type Alias Config<C>

    Config: ConditionalProperty<
        "entities",
        keyof Exactify<C["EntityMap"]>,
        {
            [E in keyof Exactify<C["EntityMap"]>]: {
                defaultLimit?: number;
                defaultPageSize?: number;
                shardBumps?: ShardBump[];
                timestampProperty: Extract<
                    Extract<
                        C["TranscodedProperties"],
                        PropertiesOfType<C["EntityMap"][E], number>,
                    >,
                    TranscodableProperties<C["EntityMap"], C["TranscodeRegistry"]>,
                >;
                uniqueProperty: Extract<
                    Extract<C["TranscodedProperties"], keyof C["EntityMap"][E]>,
                    TranscodableProperties<C["EntityMap"], C["TranscodeRegistry"]>,
                >;
            }
        },
    > & ConditionalProperty<
        "generatedProperties",
        C["ShardedKeys"]
        | C["UnshardedKeys"],
        ConditionalProperty<
            "sharded",
            C["ShardedKeys"],
            Record<
                C["ShardedKeys"],
                (
                    C["TranscodedProperties"] & TranscodableProperties<
                        C["EntityMap"],
                        C["TranscodeRegistry"],
                    >
                )[],
            >,
        > & ConditionalProperty<
            "unsharded",
            C["UnshardedKeys"],
            Record<
                C["UnshardedKeys"],
                (
                    C["TranscodedProperties"] & TranscodableProperties<
                        C["EntityMap"],
                        C["TranscodeRegistry"],
                    >
                )[],
            >,
        >,
    > & ConditionalProperty<
        "propertyTranscodes",
        C["TranscodedProperties"] & TranscodableProperties<
            C["EntityMap"],
            C["TranscodeRegistry"],
        >,
        {
            [P in C["TranscodedProperties"] & TranscodableProperties<
                C["EntityMap"],
                C["TranscodeRegistry"],
            >]: PropertiesOfType<
                C["TranscodeRegistry"],
                FlattenEntityMap<C["EntityMap"]>[P],
            >
        },
    > & ConditionalProperty<
        "transcodes",
        keyof C["TranscodeRegistry"],
        Transcodes<C["TranscodeRegistry"]>,
    > & {
        generatedKeyDelimiter?: string;
        generatedValueDelimiter?: string;
        hashKey: C["HashKey"];
        indexes?: Record<
            string,
            {
                hashKey: C["HashKey"]
                | C["ShardedKeys"];
                projections?: string[];
                rangeKey:
                    | C["RangeKey"]
                    | C["UnshardedKeys"]
                    | C["TranscodedProperties"] & TranscodableProperties<
                        C["EntityMap"],
                        C["TranscodeRegistry"],
                    >;
            },
        >;
        rangeKey: C["RangeKey"];
        shardKeyDelimiter?: string;
        throttle?: number;
    }

    Configuration object for an EntityManager instance.

    Type Parameters

    Type Declaration

    • OptionalgeneratedKeyDelimiter?: string

      Delimiter between generated key elements (default |). Must not collide with other delimiters.

    • OptionalgeneratedValueDelimiter?: string

      Delimiter between a generated property key and its encoded value (default #). Must not collide with other delimiters.

    • hashKey: C["HashKey"]

      Global hash key property name.

    • Optionalindexes?: Record<
          string,
          {
              hashKey: C["HashKey"]
              | C["ShardedKeys"];
              projections?: string[];
              rangeKey:
                  | C["RangeKey"]
                  | C["UnshardedKeys"]
                  | C["TranscodedProperties"] & TranscodableProperties<
                      C["EntityMap"],
                      C["TranscodeRegistry"],
                  >;
          },
      >

      Index token map. Keys are index names; values define the index hash/range key tokens and optional projections.

      This is provider-agnostic metadata used for page-key narrowing and (de)hydration; provider adapters map this to platform-specific indexes.

    • rangeKey: C["RangeKey"]

      Global range key property name.

    • OptionalshardKeyDelimiter?: string

      Delimiter between entity token and shard suffix in the global hash key value (default !).

    • Optionalthrottle?: number

      Maximum number of shard queries to execute concurrently during query.

    Settings

    Member Visibility