Function scan

scan(tableName: string, filter?: Filter, options?: Partial<ScanCommandInput>): Promise<ScanCommandOutput>
Returns one or more items and item attributes by accessing every item in a table or a secondary index by delegating to ScanCommand.

Example
```
df.scan('movies', { actor: 'Tom Hanks' })
```
Returns
The same response returned by send()ing this command
Parameters
- tableName: string
  
  The name of the table containing the requested items; or, if you provide IndexName in the options, the name of the table to which that index belongs
- Optional filter: Filter
  
  An object describing the comparisons used to generate FilterExpression, ExpressionAttributeNames, and ExpressionAttributeValues
- Optional options: Partial<ScanCommandInput>
  
  The options accepted by the original ScanCommand method
Returns Promise<ScanCommandOutput>
- Defined in src/index.ts:137

Generated using TypeDoc