@karmaniverous/entity-client-dynamodb
    Preparing search index...

    Interface GetDocumentQueryArgsParams<C, ET, IT, CF>

    Parameters for getDocumentQueryArgs.

    interface GetDocumentQueryArgsParams<
        C extends BaseConfigMap,
        ET extends EntityToken<C>,
        IT extends string,
        CF = unknown,
    > {
        hashKey: string;
        hashKeyToken: C["HashKey"] | C["ShardedKeys"];
        indexParamsMap: Record<IT, IndexParams>;
        indexToken: IT;
        pageKey?: PageKeyByIndex<C, ET, IT, CF>;
        pageSize?: number;
        tableName: string;
    }

    Type Parameters

    • C extends BaseConfigMap

      Entity-manager config map.

    • ET extends EntityToken<C>

      Entity token for the query.

    • IT extends string

      Index token type.

    • CF = unknown

      Values-first config literal type carried by EntityClient.

    Index

    Properties

    hashKey hashKeyToken indexParamsMap indexToken pageKey? pageSize? tableName

    Properties

    hashKey: string

    Fully-formed hash key value (including any shard suffix), bound as :hashKey.

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

    Hash key token used in the key condition expression.

    indexParamsMap: Record<IT, IndexParams>

    Per-index builder params (expression names/values, conditions, projections).

    indexToken: IT

    Index token to build the query args for.

    pageKey?: PageKeyByIndex<C, ET, IT, CF>

    Optional paging key for this index.

    pageSize?: number

    Optional per-shard page size.

    tableName: string

    Table name to query.

    Settings

    Member Visibility

    On This Page

    Properties