ProjectedQuery
Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends ZodObject
ProjectedSchema
Section titled “ProjectedSchema”ProjectedSchema extends ZodObject
Implements
Section titled “Implements”BaseCommand<ProjectedQueryResult<Schema,ProjectedSchema>,Schema>BasePaginatable<ProjectedQueryResult<Schema,ProjectedSchema>,Schema>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ProjectedQuery<Schema, ProjectedSchema>(config): ProjectedQuery<Schema, ProjectedSchema>;Parameters
Section titled “Parameters”config
Section titled “config”ProjectedQueryConfig<Schema, ProjectedSchema>
Returns
Section titled “Returns”ProjectedQuery<Schema, ProjectedSchema>
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): ProjectedQueryResult<Schema, ProjectedSchema>;Parameters
Section titled “Parameters”EntitySchema<ProjectedSchema>[]
queryResult
Section titled “queryResult”QueryCommandOutput
Returns
Section titled “Returns”ProjectedQueryResult<Schema, ProjectedSchema>
execute()
Section titled “execute()”execute(entity): Promise<ProjectedQueryResult<Schema, ProjectedSchema>>;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Returns
Section titled “Returns”Promise<ProjectedQueryResult<Schema, ProjectedSchema>>
Implementation of
Section titled “Implementation of”executePaginated()
Section titled “executePaginated()”executePaginated(entity): AsyncGenerator<ProjectedQueryResult<Schema, ProjectedSchema>, void, unknown>;Parameters
Section titled “Parameters”entity
Section titled “entity”DynamoEntity<Schema>
Returns
Section titled “Returns”AsyncGenerator<ProjectedQueryResult<Schema, ProjectedSchema>, void, unknown>
Implementation of
Section titled “Implementation of”BasePaginatable.executePaginated
validateItems()
Section titled “validateItems()”validateItems(items): Promise<EntitySchema<ProjectedSchema>[]>;Parameters
Section titled “Parameters”Record<string, any>[] | undefined
Returns
Section titled “Returns”Promise<EntitySchema<ProjectedSchema>[]>