Query
Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends ZodObject
Implements
Section titled “Implements”BaseCommand<QueryResult<Schema>,Schema>BasePaginatable<QueryResult<Schema>,Schema>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Query<Schema>(config): Query<Schema>;Parameters
Section titled “Parameters”config
Section titled “config”QueryConfig<Schema>
Returns
Section titled “Returns”Query<Schema>
Methods
Section titled “Methods”buildCommandInput()
Section titled “buildCommandInput()”buildCommandInput(entity): QueryCommandInput;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Returns
Section titled “Returns”QueryCommandInput
buildResult()
Section titled “buildResult()”buildResult(items, queryResult): QueryResult<Schema>;Parameters
Section titled “Parameters”EntitySchema<Schema>[]
queryResult
Section titled “queryResult”QueryCommandOutput
Returns
Section titled “Returns”QueryResult<Schema>
execute()
Section titled “execute()”execute(entity): Promise<QueryResult<Schema>>;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Returns
Section titled “Returns”Promise<QueryResult<Schema>>
Implementation of
Section titled “Implementation of”executePaginated()
Section titled “executePaginated()”executePaginated(entity): AsyncGenerator<QueryResult<Schema>, void, unknown>;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Returns
Section titled “Returns”AsyncGenerator<QueryResult<Schema>, void, unknown>
Implementation of
Section titled “Implementation of”BasePaginatable.executePaginated
validateItems()
Section titled “validateItems()”validateItems(entity, items): Promise<EntitySchema<Schema>[]>;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Record<string, any>[] | undefined
Returns
Section titled “Returns”Promise<EntitySchema<Schema>[]>