Node SDK
Search
Preparing search index...
The search index is not available
Menu
node-sdk
lib/dynamodb
LeoDynamodb
Inherited
Legend
Interface LeoDynamodb
Legend
Namespace
Variable
Function
Function with type parameter
Type alias
Type alias with type parameter
Interface
Interface with type parameter
Property
Method
Enumeration
Class
Helper functions to interact with Dynamo DB.
Hierarchy
LeoDynamodb
Index
Properties
doc
Client
Methods
batch
Get
Hashkey
batch
Get
Table
batch
Table
Write
create
Table
Write
Stream
get
get
Setting
get
Setting
Promise
merge
put
query
save
Setting
scan
set
Setting
Promise
update
update
Multi
Properties
doc
Client
doc
Client
:
DocumentClient
Methods
batch
Get
Hashkey
batch
Get
Hashkey
(
table
:
string
, hashkey
:
any
, ids
:
any
, opts
:
any
, callback
:
any
)
:
void
Parameters
table:
string
hashkey:
any
ids:
any
opts:
any
callback:
any
Returns
void
batch
Get
Table
batch
Get
Table
(
table
:
string
, keys
:
any
, opts
:
any
, callback
:
any
)
:
void
Parameters
table:
string
keys:
any
opts:
any
callback:
any
Returns
void
batch
Table
Write
batch
Table
Write
(
table
:
string
, records
:
any
, callback
:
any
)
:
void
Parameters
table:
string
records:
any
callback:
any
Returns
void
create
Table
Write
Stream
create
Table
Write
Stream
(
table
:
string
, opts
:
any
)
:
void
Parameters
table:
string
opts:
any
Returns
void
get
get
<
T
>
(
table
:
string
, id
:
string
, opts
:
GetOptions
, callback
:
DataCallback
<
AWSError
,
T
>
)
:
void
Type parameters
T
Parameters
table:
string
id:
string
opts:
GetOptions
callback:
DataCallback
<
AWSError
,
T
>
Returns
void
get
Setting
get
Setting
<
T
>
(
setting_id
:
string
, callback
:
DataCallback
<
AWSError
,
T
>
)
:
void
Type parameters
T
Parameters
setting_id:
string
callback:
DataCallback
<
AWSError
,
T
>
Returns
void
get
Setting
Promise
get
Setting
Promise
<
T
>
(
setting_id
:
string
)
:
Promise
<
T
>
Type parameters
T
Parameters
setting_id:
string
Returns
Promise
<
T
>
merge
merge
(
table
:
string
, id
:
string
, obj
:
any
, opts
:
any
, callback
:
any
)
:
void
Parameters
table:
string
id:
string
obj:
any
opts:
any
callback:
any
Returns
void
put
put
<
T
>
(
table
:
string
, id
:
string
, item
:
T
, opts
:
PutOptions
, callback
:
Callback
<
AWSError
>
)
:
void
Type parameters
T
Parameters
table:
string
id:
string
item:
T
opts:
PutOptions
callback:
Callback
<
AWSError
>
Returns
void
query
query
(
params
:
any
, configuration
?:
any
, stats
?:
any
)
:
Promise
<
any
>
Parameters
params:
any
Optional
configuration:
any
Optional
stats:
any
Returns
Promise
<
any
>
save
Setting
save
Setting
<
T
>
(
setting_id
:
string
, value
:
T
, callback
:
Callback
<
AWSError
>
)
:
void
Type parameters
T
Parameters
setting_id:
string
value:
T
callback:
Callback
<
AWSError
>
Returns
void
scan
scan
(
table
:
string
, filter
:
any
, callback
:
any
)
:
void
Parameters
table:
string
filter:
any
callback:
any
Returns
void
set
Setting
Promise
set
Setting
Promise
<
T
>
(
setting_id
:
string
, value
:
T
)
:
Promise
<
void
>
Type parameters
T
Parameters
setting_id:
string
value:
T
Returns
Promise
<
void
>
update
update
(
table
:
string
, key
:
any
, set
:
any
, opts
:
any
, callback
:
any
)
:
void
Parameters
table:
string
key:
any
set:
any
opts:
any
callback:
any
Returns
void
update
Multi
update
Multi
(
items
:
any
, opts
:
any
, callback
:
any
)
:
void
Parameters
items:
any
opts:
any
callback:
any
Returns
void
Modules
index
lib/cron
lib/dynamodb
lib/rstreams-
config-
provider-
chain
lib/rstreams-
configuration
lib/streams
lib/types
Leo
Dynamodb
doc
Client
batch
Get
Hashkey
batch
Get
Table
batch
Table
Write
create
Table
Write
Stream
get
get
Setting
get
Setting
Promise
merge
put
query
save
Setting
scan
set
Setting
Promise
update
update
Multi
Generated using
TypeDoc
Helper functions to interact with Dynamo DB.