PreparedBatchGet
type PreparedBatchGet<Schema> = object;Represents a BatchGet command bound to a specific entity, ready to be included in a table-level TableBatchGet command.
Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends ZodObject
The Zod schema type associated with the DynamoEntity.
Properties
Section titled “Properties”consistent
Section titled “consistent”consistent: boolean;entity
Section titled “entity”entity: DynamoEntity<Schema>;keys: DynamoKey[];Methods
Section titled “Methods”matchItem()
Section titled “matchItem()”matchItem(item): boolean;Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”boolean
matchUnprocessedKey()
Section titled “matchUnprocessedKey()”matchUnprocessedKey(key): | Partial<EntitySchema<Schema>> | undefined;Parameters
Section titled “Parameters”Returns
Section titled “Returns”| Partial<EntitySchema<Schema>>
| undefined
parseResults()
Section titled “parseResults()”parseResults(items, skipValidation): Promise<EntitySchema<Schema>[]>;Parameters
Section titled “Parameters”unknown[]
skipValidation
Section titled “skipValidation”boolean
Returns
Section titled “Returns”Promise<EntitySchema<Schema>[]>