ScanConfig
type ScanConfig<Schema> = BaseConfig & object;Configuration for the Scan command.
Type Declaration
Section titled “Type Declaration”consistent?
Section titled “consistent?”optional consistent: boolean;exclusiveStartKey?
Section titled “exclusiveStartKey?”optional exclusiveStartKey: Partial<EntitySchema<Schema>>;filter?
Section titled “filter?”optional filter: Condition;indexName?
Section titled “indexName?”optional indexName: string;limit?
Section titled “limit?”optional limit: number;pageSize?
Section titled “pageSize?”optional pageSize: number;segment?
Section titled “segment?”optional segment: number;selectAttributes?
Section titled “selectAttributes?”optional selectAttributes: Select;totalSegments?
Section titled “totalSegments?”optional totalSegments: number;validationConcurrency?
Section titled “validationConcurrency?”optional validationConcurrency: number;Type Parameters
Section titled “Type Parameters”Schema
Section titled “Schema”Schema extends ZodObject
The Zod schema defining the structure of the entity.