Function scan

  • Returns one or more items and item attributes by accessing every item in a table or a secondary index by delegating to DocumentClient.scan.

    Example

    df.scan('movies', { actor: 'Tom Hanks' })

    Returns

    The same response returned by scan().promise()

    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

    • filter: AttributeMap

      An object describing the comparisons used to generate FilterExpression, ExpressionAttributeNames, and ExpressionAttributeValues

    • Optional options: ScanInput

      The options accepted by the original scan method

    Returns Promise<PromiseResult<ScanOutput, AWSError>>

Settings

Member Visibility

Theme

Generated using TypeDoc