Count

Methods

(inner) count(request) → {Promise}

Description:

• Return the number of elements in a table or a secondary index. This function uses Scan internally and retrieves the returned Count attribute from its response.

Source:

• count.js, line 38

See:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html#API_Scan_RequestSyntax

Example

// Returns the total count of items in `SomeTable`
await count({ TableName: 'SomeTable' });

Parameters:

Returns:

Type

Promise

(inner) countFor(tableName, requestopt) → {Promise}

Description:

• Creates a function that returns the number of elements in a table or a secondary index. This function uses Scan internally and retrieves the returned Count attribute from its response. The last request argument is optional and is only required if any non mandatory attribute needs to be included in the request. You would typically use this function through forTable.

Source:

• count.js, line 64

See:

• https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Scan.html

Examples

// Returns the total count of items in `SomeTable`
 await countFor('SomeTable')();

// Exported from `forTable`
 const { count } = forTable('SomeTable');
 await count();

Parameters:

Returns:

Type

Promise