taler-docs

commit 4d7e7fa25aeb61faf206349528bfc87fa2753e26
parent 0b0e20a8ca942a969110935075363983adf39d35
Author: Florian Dold <florian@dold.me>
Date:   Wed,  2 Oct 2024 17:35:38 +0200

update wallet-core docs

Diffstat:
M
wallet/wallet-core.md
 | 
15
+++++++++++++++

1 file changed, 15 insertions(+), 0 deletions(-)
diff --git a/wallet/wallet-core.md b/wallet/wallet-core.md
@@ -526,8 +526,23 @@ export interface GetTransactionsV2Request {
   offsetTimestamp?: TalerPreciseTimestamp;
   /**
    * 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";
 }