fix docs in internalTransactionsService

ACHIVX-COM · Jul 1, 2024 · 6a428e1 · 6a428e1
1 parent dc9ea0a
commit 6a428e1
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/services/internalTransactionsService.js b/src/services/internalTransactionsService.js
@@ -18,6 +18,7 @@ module.exports.InsufficientFundsError = InsufficientFundsError;
 
 /**
  * @typedef {Object} TransactionCreationParameters
+ * @property {STATUSES} status
  * @property {mongoose.Types.ObjectId} account
  * @property {string} amount
  * @property {Object<string, string>} meta
@@ -29,6 +30,7 @@ module.exports.InsufficientFundsError = InsufficientFundsError;
  * @param {TransactionCreationParameters[]} parameters
  * @param {mongoose.ClientSession} session mongodb session
  * @returns {Promise<InternalTransactionModel>}
+ * @throws {InsufficientFundsError} if at least one of accounts has its balance gone below zero. The mongodb transaction MUST be reverted in case of such error.
  */
 const createTransactions = (module.exports.createTransactions =
   async function createTransactions(parameters, session) {