Class: DynamoDeleteQueue

DynamoDeleteQueue~DynamoDeleteQueue(dynamoCredentials, dynamoRegion, tableName)

Creates a new Queue for removing data from Dynamo.

Constructor

new DynamoDeleteQueue(dynamoCredentials, dynamoRegion, tableName)

Constructor for DynamoDeleteQueue

Parameters:
Name Type Description
dynamoCredentials module:dynamo.DynamoCredentials

The credentials for a Dynamo table
dynamoRegion string

The region of the Dynamo table we're using
tableName string

The name of the table we want to remove data from
Source:

Methods

push(item, callbacknullable) → {void}

Method to push items to our queue

Parameters:
Name Type Attributes Description
item module:DynamoDeleteQueue.DeleteQueueItem

Any item that we want to delete
callback function <nullable>

A method to call once the item has been deleted
Source:
Returns:

Nothing

Type
void

pushBatch(batch, callbacknullable) → {void}

Method to push items to our queue

Parameters:
Name Type Attributes Description
batch Array.<module:DynamoDeleteQueue.DeleteQueueItem>

A batch of items to delete from the db
callback function <nullable>

A method to call once the item has been deleted
Source:
Returns:

Nothing

Type
void