taler-typescript-core

commit f1c9bb825bd324630b54b9620b9ce488e2acf188
parent d7d8dee0f6c07b20ec1f1d481a0505f7c87a4055
Author: Florian Dold <florian@dold.me>
Date:   Wed,  2 Oct 2024 17:32:27 +0200

-docs

Diffstat:
M
packages/taler-util/src/types-taler-wallet-transactions.ts
 | 
15
+++++++++++++++

1 file changed, 15 insertions(+), 0 deletions(-)
diff --git a/packages/taler-util/src/types-taler-wallet-transactions.ts b/packages/taler-util/src/types-taler-wallet-transactions.ts
@@ -131,9 +131,24 @@ export interface GetTransactionsV2Request {
 
   /**
    * Number of transactions to return.
+   *
+   * When the limit is positive, results are returned
+   * in ascending order of their timestamp.  If no offset is specified,
+   * the result list begins with the first transaction.
+   * If an offset is specified, transactions after the offset are returned.
+   *
+   * When the limit is negative, results are returned
+   * in descending order of their timestamp.  If no offset is specified,
+   * the result list begins with with the last transaction.
+   * If an offset is specified, transactions before the offset are returned.
    */
   limit?: number;
 
+  /**
+   * Filter transactions by their state / state category.
+   *
+   * If not specified, all transactions are returned.
+   */
   filterState?: "final" | "nonfinal" | "done";
 }