Interface BaseQueryBuilderOptions<C, EntityClient>

Constructor options for BaseQueryBuilder.

interface BaseQueryBuilderOptions<
    C extends BaseConfigMap,
    EntityClient extends BaseEntityClient<C>,
> {
    entityClient: EntityClient;
    entityToken: EntityToken<C>;
    hashKeyToken: C["HashKey"] | C["ShardedKeys"];
    pageKeyMap?: string;
}

Type Parameters

C extends BaseConfigMap
ConfigMap that defines an EntityManager configuration's EntityMap, key properties, and TranscodeMap. If omitted, defaults to BaseConfigMap.
EntityClient extends BaseEntityClient<C>
BaseEntityClient derived class instance.

Index

Properties

entityClient entityToken hashKeyToken pageKeyMap?

Properties

entityClient

entityClient: EntityClient

EntityClient instance.

entityToken

entityToken: EntityToken<C>

Entity token.

hashKeyToken

hashKeyToken: C["HashKey"] | C["ShardedKeys"]

Hash key token.

`Optional`pageKeyMap

pageKeyMap?: string

Dehydrated page key map.