@shiftcoders/dynamo-easy
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Base
Request
Batch
Get
Single
Table
Request
Batch
Write
Single
Table
Request
constructor
dynamoDBWrapper
metadata
model
Clazz
params
table
Name
delete
exec
exec
Full
Response
put
return
Consumed
Capacity
return
Item
Collection
Metrics
Delete
Request
Get
Request
Put
Request
Query
Request
Read
Many
Request
Scan
Request
Standard
Request
Transact
Get
Single
Table
Request
Update
Request
Write
Request
Batch
Get
Single
Table
Response
Delete
Response
Get
Response
Put
Response
Query
Response
Scan
Response
Update
Response
Transact
Get
Response
Write
Response
Type parameters
T
T2
Hierarchy
BaseRequest
<
T
,
T2
,
BatchWriteItemInput
,
BatchWriteSingleTableRequest
<
T
,
T2
>
>
BatchWriteSingleTableRequest
Index
Constructors
constructor
Properties
dynamoDBWrapper
metadata
model
Clazz
params
table
Name
Methods
delete
exec
exec
Full
Response
put
return
Consumed
Capacity
return
Item
Collection
Metrics
Constructors
constructor
new
Batch
Write
Single
Table
Request
(
dynamoDBWrapper
:
DynamoDbWrapper
, modelClazz
:
ModelConstructor
<
T
>
)
:
BatchWriteSingleTableRequest
Parameters
dynamoDBWrapper:
DynamoDbWrapper
modelClazz:
ModelConstructor
<
T
>
Returns
BatchWriteSingleTableRequest
Properties
dynamoDBWrapper
dynamoDBWrapper
:
DynamoDbWrapper
metadata
metadata
:
Metadata
<
T
>
model
Clazz
model
Clazz
:
ModelConstructor
<
T
>
params
params
:
BatchWriteItemInput
table
Name
table
Name
:
string
Methods
delete
delete
(
items
:
Array
<
Partial
<
T
>
>
)
:
this
Parameters
items:
Array
<
Partial
<
T
>
>
Returns
this
exec
exec
(
backoffTimer
?:
randomExponentialBackoffTimer
, throttleTimeSlot
?:
number
)
:
Promise
<
void
>
Parameters
Default value
backoffTimer:
randomExponentialBackoffTimer
= randomExponentialBackoffTimer
Default value
throttleTimeSlot:
number
= BATCH_WRITE_DEFAULT_TIME_SLOT
Returns
Promise
<
void
>
exec
Full
Response
exec
Full
Response
(
backoffTimer
?:
randomExponentialBackoffTimer
, throttleTimeSlot
?:
number
)
:
Promise
<
BatchWriteItemOutput
>
Parameters
Default value
backoffTimer:
randomExponentialBackoffTimer
= randomExponentialBackoffTimer
Default value
throttleTimeSlot:
number
= BATCH_WRITE_DEFAULT_TIME_SLOT
Returns
Promise
<
BatchWriteItemOutput
>
put
put
(
items
:
T
[]
)
:
this
Parameters
items:
T
[]
Returns
this
return
Consumed
Capacity
return
Consumed
Capacity
(
level
:
DynamoDB.ReturnConsumedCapacity
)
:
BatchWriteSingleTableRequest
<
T
,
T2
>
Parameters
level:
DynamoDB.ReturnConsumedCapacity
Returns
BatchWriteSingleTableRequest
<
T
,
T2
>
return
Item
Collection
Metrics
return
Item
Collection
Metrics
(
value
:
DynamoDB.ReturnItemCollectionMetrics
)
:
this
Parameters
value:
DynamoDB.ReturnItemCollectionMetrics
Returns
this