[tools] Add addStartTransactionListener

Author: jamesgpearce

src/tools/api/core.ts

@@ -969,6 +969,16 @@ export const getStoreCoreApi = (
     storeType,
   );
 
+  // addStartTransactionListener
+  addProxyListener(
+    'Start' + TRANSACTION,
+    transactionListenerType,
+    REGISTERS_A_LISTENER + ' just before the start of the ' + TRANSACTION_,
+    EMPTY_STRING,
+    EMPTY_STRING,
+    0,
+  );
+
   // addWillFinishTransactionListener
   addProxyListener(
     'WillFinish' + TRANSACTION,

test/unit/__snapshots__/tools.test.ts.snap

@@ -834,6 +834,12 @@ export interface S {
    */
   finishTransaction(doRollback?: DoRollback): S;
 
+  /**
+   * Registers a listener that will be called just before the start of the
+   * transaction.
+   */
+  addStartTransactionListener(listener: TransactionListener): Id;
+
   /**
    * Registers a listener that will be called just before the end of the
    * transaction.
@@ -1234,6 +1240,9 @@ export const createS: typeof createSDecl = () => {
     finishTransaction: (doRollback?: DoRollback): S =>
       fluent(() => store.finishTransaction(doRollback)),
 
+    addStartTransactionListener: (listener: TransactionListener): Id =>
+      store.addStartTransactionListener(proxy(listener)),
+
     addWillFinishTransactionListener: (listener: TransactionListener): Id =>
       store.addWillFinishTransactionListener(proxy(listener)),
 
@@ -3389,6 +3398,12 @@ export interface S {
    */
   finishTransaction(doRollback?: DoRollback): S;
 
+  /**
+   * Registers a listener that will be called just before the start of the
+   * transaction.
+   */
+  addStartTransactionListener(listener: TransactionListener): Id;
+
   /**
    * Registers a listener that will be called just before the end of the
    * transaction.
@@ -3569,6 +3584,9 @@ export const createS: typeof createSDecl = () => {
     finishTransaction: (doRollback?: DoRollback): S =>
       fluent(() => store.finishTransaction(doRollback)),
 
+    addStartTransactionListener: (listener: TransactionListener): Id =>
+      store.addStartTransactionListener(proxy(listener)),
+
     addWillFinishTransactionListener: (listener: TransactionListener): Id =>
       store.addWillFinishTransactionListener(proxy(listener)),
 
@@ -4838,6 +4856,12 @@ export interface S {
    */
   finishTransaction(doRollback?: DoRollback): S;
 
+  /**
+   * Registers a listener that will be called just before the start of the
+   * transaction.
+   */
+  addStartTransactionListener(listener: TransactionListener): Id;
+
   /**
    * Registers a listener that will be called just before the end of the
    * transaction.
@@ -5141,6 +5165,9 @@ export const createS: typeof createSDecl = () => {
     finishTransaction: (doRollback?: DoRollback): S =>
       fluent(() => store.finishTransaction(doRollback)),
 
+    addStartTransactionListener: (listener: TransactionListener): Id =>
+      store.addStartTransactionListener(proxy(listener)),
+
     addWillFinishTransactionListener: (listener: TransactionListener): Id =>
       store.addWillFinishTransactionListener(proxy(listener)),
 
@@ -6867,6 +6894,9 @@ startTransaction(): S;
 /** Explicitly finishes a transaction. */
 finishTransaction(doRollback?: DoRollback): S;
 
+/** Registers a listener that will be called just before the start of the transaction. */
+addStartTransactionListener(listener: TransactionListener): Id;
+
 /** Registers a listener that will be called just before the end of the transaction. */
 addWillFinishTransactionListener(listener: TransactionListener): Id;
 
@@ -7106,6 +7136,8 @@ startTransaction: (): S => fluent(() => store.startTransaction()),
 
 finishTransaction: (doRollback?: DoRollback): S => fluent(() => store.finishTransaction(doRollback)),
 
+addStartTransactionListener: (listener: TransactionListener): Id => store.addStartTransactionListener(proxy(listener)),
+
 addWillFinishTransactionListener: (listener: TransactionListener): Id => store.addWillFinishTransactionListener(proxy(listener)),
 
 addDidFinishTransactionListener: (listener: TransactionListener): Id => store.addDidFinishTransactionListener(proxy(listener)),
@@ -7843,6 +7875,9 @@ startTransaction(): S;
 /** Explicitly finishes a transaction. */
 finishTransaction(doRollback?: DoRollback): S;
 
+/** Registers a listener that will be called just before the start of the transaction. */
+addStartTransactionListener(listener: TransactionListener): Id;
+
 /** Registers a listener that will be called just before the end of the transaction. */
 addWillFinishTransactionListener(listener: TransactionListener): Id;
 
@@ -7970,6 +8005,8 @@ startTransaction: (): S => fluent(() => store.startTransaction()),
 
 finishTransaction: (doRollback?: DoRollback): S => fluent(() => store.finishTransaction(doRollback)),
 
+addStartTransactionListener: (listener: TransactionListener): Id => store.addStartTransactionListener(proxy(listener)),
+
 addWillFinishTransactionListener: (listener: TransactionListener): Id => store.addWillFinishTransactionListener(proxy(listener)),
 
 addDidFinishTransactionListener: (listener: TransactionListener): Id => store.addDidFinishTransactionListener(proxy(listener)),
@@ -8508,6 +8545,9 @@ startTransaction(): S;
 /** Explicitly finishes a transaction. */
 finishTransaction(doRollback?: DoRollback): S;
 
+/** Registers a listener that will be called just before the start of the transaction. */
+addStartTransactionListener(listener: TransactionListener): Id;
+
 /** Registers a listener that will be called just before the end of the transaction. */
 addWillFinishTransactionListener(listener: TransactionListener): Id;
 
@@ -8677,6 +8717,8 @@ startTransaction: (): S => fluent(() => store.startTransaction()),
 
 finishTransaction: (doRollback?: DoRollback): S => fluent(() => store.finishTransaction(doRollback)),
 
+addStartTransactionListener: (listener: TransactionListener): Id => store.addStartTransactionListener(proxy(listener)),
+
 addWillFinishTransactionListener: (listener: TransactionListener): Id => store.addWillFinishTransactionListener(proxy(listener)),
 
 addDidFinishTransactionListener: (listener: TransactionListener): Id => store.addDidFinishTransactionListener(proxy(listener)),