You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 7-8.RSVP
Socket
Socket
Sign inDemoInstall

@veterancrowd/wrapped-dynamodb-client

Package Overview
Dependencies
Maintainers
0
Versions
42
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@veterancrowd/wrapped-dynamodb-client

An AWS DynamoDB client wrapped to provide consistent logging and other services.


Version published
Maintainers
0
Created

Readme

Source

WrappedDynamoDbClient

This package wraps the DynamoDB Client - AWS SDK for JavaScript v3 to provide a streamlined developer experience and consistent logging.

API Documentation

wrapped-dynamodb-client.WrappedDynamoDbClient

Wraps an AWS DynamoDB client to provide standard logging & services.

Kind: static class of wrapped-dynamodb-client

new exports.WrappedDynamoDbClient([options])

WrappedDynamoDbClient constructor.

ParamTypeDescription
[options]objectOptions.
[options.logger]objectLogger instance (default is global console object). Must have info, error & debug methods
[options.logInternals]booleanLog AWS client internals (default is false).
[options.config]objectDynamoDBClientConfig object.

wrappedDynamoDbClient.deleteItem(tableName, key) ⇒ Promise.<object>

Delete an item from a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<object> - WaiterResult object.
Category: item

ParamTypeDescription
tableNamestringTable name.
keyobjectItem object (only the key is required).

wrappedDynamoDbClient.deleteItems(tableName, keys) ⇒ Promise.<number>

Delete multiple items from a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<number> - Array of responses from chunked batchWrite operations.
Category: item

ParamTypeDescription
tableNamestringTable name.
keysArray.<object>Array of item objects (only the key is required).

wrappedDynamoDbClient.getItem(tableName, key, [attributes]) ⇒ Promise.<object>

Get an item from a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<object> - - GetItemCommandOutput object.
Category: item

ParamTypeDescription
tableNamestringTable name.
keyobjectItem object (only the key is required).
[attributes]string | Array.<string>Comma-delimited list or string array of attributes to retrieve.

wrappedDynamoDbClient.purgeItems(tableName, keys) ⇒ Promise.<number>

Purge all items from a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<number> - Total items purged from table.
Category: item

ParamTypeDescription
tableNamestringTable name.
keysArray.<string>Item keys.

wrappedDynamoDbClient.putItem(tableName, item) ⇒ Promise.<object>

Put an item into a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<object> - - PutItemCommandOutput object.
Category: item

ParamTypeDescription
tableNamestringTable name.
itemobjectItem object.

wrappedDynamoDbClient.putItems(tableName, items) ⇒ Promise.<Array>

Put multiple items into a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<Array> - Array of responses from chunked batchWrite operations.
Category: item

ParamTypeDescription
tableNamestringTable name.
itemsArray.<object>Array of item objects.

wrappedDynamoDbClient.query(tableName, options) ⇒ Promise.<object>

Query items from a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<object> - QueryCommandOutput object.
Category: item

ParamTypeDescription
tableNamestringTable name.
optionsobjectQueryCommandInput object.

wrappedDynamoDbClient.scan(tableName, options) ⇒ Promise.<object>

Scan items from a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<object> - ScanCommandOutput object.
Category: item

ParamTypeDescription
tableNamestringTable name.
optionsobjectScanCommandInput object.

wrappedDynamoDbClient.transactDeleteItems(tableName, keys) ⇒ Promise.<Array>

Delete multiple items from a DynamoDB table as a single transaction.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<Array> - Array of responses from chunked batchWrite operations.
Category: item

ParamTypeDescription
tableNamestringTable name.
keysArray.<object>Array of item keys.

wrappedDynamoDbClient.transactPutItems(tableName, items) ⇒ Promise.<Array>

Put multiple items into a DynamoDB table as a single transaction.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<Array> - Array of responses from chunked batchWrite operations.
Category: item

ParamTypeDescription
tableNamestringTable name.
itemsArray.<object>Array of item objects.

wrappedDynamoDbClient.createTable(tableName, [options]) ⇒ Promise.<object>

Create a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<object> - WaiterResult object.
Category: table

ParamTypeDescription
tableNamestringTable name.
[options]objectCreateTableCommandInput object.

wrappedDynamoDbClient.deleteTable(tableName) ⇒ Promise.<object>

Delete a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<object> - - Deletion status
Category: table

ParamTypeDescription
tableNamestringTable name.

wrappedDynamoDbClient.describeTable(tableName) ⇒ Promise.<object>

Describe a DynamoDB table.

Kind: instance method of WrappedDynamoDbClient
Returns: Promise.<object> - - TableDescription}
Category: table

ParamTypeDescription
tableNamestringTable name.

See more great templates and other tools on my GitHub Profile!

Keywords

FAQs

Package last updated on 17 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc