duenamodb/lib/scan.d.ts

Simple DynamoDB client written in TypeScript.

import { ScanCommandInput } from '@aws-sdk/client-dynamodb';
import { FilterOptions } from './expression';
import { DynamoDBTypes } from './types';
type DynamoDBOptions = Omit<ScanCommandInput, 'TableName'>;
export type ScanOptions<Attributes extends DynamoDBTypes> = {
    filterOptions?: FilterOptions<Attributes>;
    dynamodbOptions?: DynamoDBOptions;
};
export type ScanItemsFunction<Attributes extends DynamoDBTypes> = (options?: ScanOptions<Attributes>) => Promise<Attributes[]>;
export declare const createScanItems: <Attributes extends DynamoDBTypes>(tablename: string) => ScanItemsFunction<Attributes>;
export declare const createScanOptions: <Attributes extends DynamoDBTypes>(filterOptions?: FilterOptions<Attributes> | undefined) => Partial<DynamoDBOptions>;
export declare const scanItems: <T>(tablename: string, options: DynamoDBOptions) => Promise<T[]>;
export {};