Skip to content

Commit ae131a6

Browse files
committed
add jsdoc for TS - WIP
1 parent 948f2f1 commit ae131a6

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

src/classes/Table.ts

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,10 @@ class Table {
201201
}
202202
} // end DocumentClient
203203

204-
// Adds a new Entity to the table
204+
/**
205+
* Adds an entity to the table
206+
* @param {Entity|Entity[]} Entity - An Entity or array of Entities to add to the table.
207+
*/
205208
addEntity(entity: ParsedEntity | ParsedEntity[]) {
206209

207210
// Coerce entity to array
@@ -1153,7 +1156,14 @@ class Table {
11531156

11541157

11551158

1156-
// Generate BatchWrite Params
1159+
/**
1160+
* Generates parameters for a batchWrite
1161+
* @param {object} items - An array of objects generated from putBatch and/or deleteBatch entity calls.
1162+
* @param {object} [options] - Additional batchWrite options
1163+
* @param {object} [params] - Additional DynamoDB parameters you wish to pass to the batchWrite request.
1164+
* @param {boolean} [meta] - Internal flag to enable entity parsing
1165+
*
1166+
*/
11571167
batchWriteParams(
11581168
_items: any,
11591169
options: batchWriteOptions = {},
@@ -1260,7 +1270,7 @@ class Table {
12601270

12611271

12621272
/**
1263-
* Generate parameters for a transactGet operation
1273+
* Generates parameters for a transactGet operation
12641274
* @param {object} items - An array of objects generated from getTransaction entity calls.
12651275
* @param {object} [options] - Additional transactGet options
12661276
*
@@ -1301,7 +1311,7 @@ class Table {
13011311
Entities.push(Entity)
13021312
if (!('Get' in _item) || Object.keys(_item).length > 1)
13031313
error(`Invalid transaction item. Use the 'getTransaction' method on an entity.`)
1304-
return item
1314+
return _item
13051315
})
13061316
},
13071317
capacity ? { ReturnConsumedCapacity: capacity.toUpperCase() } : null
@@ -1348,7 +1358,7 @@ class Table {
13481358

13491359

13501360
/**
1351-
* Generate parameters for a transactWrite operation
1361+
* Generates parameters for a transactWrite operation
13521362
* @param {object} items - An array of objects generated from putTransaction, updateTransaction, or deleteTransaction entity calls.
13531363
* @param {object} [options] - Additional options
13541364
*

0 commit comments

Comments
 (0)