algosdk 1.15.0 → 1.16.0

package/dist/cjs/src/client/v2/indexer/searchAccounts.js

@@ -4,57 +4,257 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonrequest_1 = __importDefault(require("../jsonrequest"));
+/**
+ * Returns information about indexed accounts.
+ *
+ * #### Example
+ * ```typescript
+ * const accounts = await indexerClient.searchAccounts().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2accounts)
+ * @category GET
+ */
 class SearchAccounts extends jsonrequest_1.default {
+    /**
+     * @returns `/v2/accounts`
+     */
     // eslint-disable-next-line class-methods-use-this
     path() {
         return '/v2/accounts';
     }
-    // filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units
+    /**
+     * Filtered results should have an amount greater than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
+     *
+     * #### Example 1
+     * ```typescript
+     * const minBalance = 300000;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const minBalance = 300000;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .assetID(assetID)
+     *        .currencyGreaterThan(minBalance - 1)
+     *        .do();
+     * ```
+     * @remarks
+     * If you are looking for accounts with the currency amount greater than 0, simply construct the query without `currencyGreaterThan` because it doesn't accept `-1`, and passing the `0` `currency-greater-than` value would exclude transactions with a 0 amount.
+     *
+     * @param greater
+     * @category query
+     */
     currencyGreaterThan(greater) {
         this.query['currency-greater-than'] = greater;
         return this;
     }
-    // filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units
+    /**
+     * Filtered results should have an amount less than this value, as int, representing microAlgos, unless an asset-id is provided, in which case units are in the asset's units.
+     *
+     * #### Example 1
+     * ```typescript
+     * const maxBalance = 500000;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetID = 163650;
+     * const maxBalance = 500000;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .assetID(assetID)
+     *        .currencyLessThan(maxBalance + 1)
+     *        .do();
+     * ```
+     *
+     * @param lesser
+     * @category query
+     */
     currencyLessThan(lesser) {
         this.query['currency-less-than'] = lesser;
         return this;
     }
-    // limit for filter, as int
+    /**
+     * Maximum number of results to return.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit
+     * @category query
+     */
     limit(limit) {
         this.query.limit = limit;
         return this;
     }
-    // asset ID to filter with, as int
+    /**
+     * Asset ID to filter with.
+     *
+     * #### Example
+     * ```typescript
+     * const assetID = 163650;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .assetID(assetID)
+     *        .do();
+     * ```
+     *
+     * @param id
+     * @category query
+     */
     assetID(id) {
         this.query['asset-id'] = id;
         return this;
     }
-    // used for pagination
+    /**
+     * The next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 25;
+     *
+     * const accountsPage1 = await indexerClient
+     *        .searchAccounts()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const accountsPage2 = await indexerClient
+     *        .searchAccounts()
+     *        .limit(maxResults)
+     *        .nextToken(accountsPage1["next-token"])
+     *        .do();
+     * ```
+     *
+     * @param nextToken - provided by the previous results
+     * @category query
+     */
     nextToken(nextToken) {
         this.query.next = nextToken;
         return this;
     }
-    // specific round to search
+    /**
+     * Include results for the specified round.
+     *
+     * #### Example
+     * ```typescript
+     * const targetBlock = 18309917;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .round(targetBlock)
+     *        .do();
+     * ```
+     * @remarks For performance reasons, this parameter may be disabled on some configurations.
+     * @param round
+     * @category query
+     */
     round(round) {
         this.query.round = round;
         return this;
     }
-    // include accounts that use this spending key
+    /**
+     * Include accounts that use this spending key.
+     *
+     * #### Example
+     * ```typescript
+     * const authAddr = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .authAddr(authAddr)
+     *        .do();
+     * ```
+     *
+     * @param authAddr
+     */
     authAddr(authAddr) {
         this.query['auth-addr'] = authAddr;
         return this;
     }
-    // filter for this application
+    /**
+     * Filter for this application.
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .applicationID(appId)
+     *        .do();
+     * ```
+     *
+     * @param applicationID
+     * @category query
+     */
     applicationID(applicationID) {
         this.query['application-id'] = applicationID;
         return this;
     }
-    // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const assetId = 163650;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assetId = 163650;
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value = true) {
         this.query['include-all'] = value;
         return this;
     }
-    // exclude
+    /**
+     * Exclude additional items such as asset holdings, application local data stored for this account, asset parameters created by this account, and application parameters created by this account.
+     *
+     * #### Example 1
+     * ```typescript
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .exclude("all")
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const accounts = await indexerClient
+     *        .searchAccounts()
+     *        .exclude("assets,created-assets")
+     *        .do();
+     * ```
+     * @remarks By default, it behaves as exclude=none
+     * @param exclude - Array of `all`, `assets`, `created-assets`, `apps-local-state`, `created-apps`, `none`
+     * @category query
+     */
     exclude(exclude) {
         this.query.exclude = exclude;
         return this;

package/dist/cjs/src/client/v2/indexer/searchAccounts.js.map

@@ -1 +1 @@
-{"version":3,"file":"searchAccounts.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/searchAccounts.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAEzC,MAAqB,cAAe,SAAQ,qBAAW;IACrD,kDAAkD;IAClD,IAAI;QACF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,gLAAgL;IAChL,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,6KAA6K;IAC7K,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,kCAAkC;IAClC,OAAO,CAAC,EAAU;QAChB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sBAAsB;IACtB,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8CAA8C;IAC9C,QAAQ,CAAC,QAAgB;QACvB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8BAA8B;IAC9B,aAAa,CAAC,aAAqB;QACjC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wJAAwJ;IACxJ,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,UAAU;IACV,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAjED,iCAiEC"}
+{"version":3,"file":"searchAccounts.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/searchAccounts.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAEzC;;;;;;;;;;GAUG;AACH,MAAqB,cAAe,SAAQ,qBAAW;IACrD;;OAEG;IACH,kDAAkD;IAClD,IAAI;QACF,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,mBAAmB,CAAC,OAAe;QACjC,IAAI,CAAC,KAAK,CAAC,uBAAuB,CAAC,GAAG,OAAO,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,gBAAgB,CAAC,MAAc;QAC7B,IAAI,CAAC,KAAK,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,EAAU;QAChB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,QAAgB;QACvB,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,aAAa,CAAC,aAAqB;QACjC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,aAAa,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA9PD,iCA8PC"}

package/dist/cjs/src/client/v2/indexer/searchForApplications.js

@@ -4,32 +4,128 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonrequest_1 = __importDefault(require("../jsonrequest"));
+/**
+ * Returns information about indexed applications.
+ *
+ * #### Example
+ * ```typescript
+ * const apps = await indexerClient.searchForApplications().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2applications)
+ * @category GET
+ */
 class SearchForApplications extends jsonrequest_1.default {
+    /**
+     * @returns `/v2/applications`
+     */
     // eslint-disable-next-line class-methods-use-this
     path() {
         return '/v2/applications';
     }
-    // application ID for filter, as int
+    /**
+     * Application ID for filter, as int
+     *
+     * #### Example
+     * ```typescript
+     * const appId = 60553466;
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .index(appId)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupApplications(appId).do()`
+     * @param index
+     * @category query
+     */
     index(index) {
         this.query['application-id'] = index;
         return this;
     }
-    // creator for filter, as string
+    /**
+     * Creator for filter, as string
+     *
+     * #### Example
+     * ```typescript
+     * const creator = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .creator(creator)
+     *        .do();
+     * ```
+     * @param creator
+     * @category query
+     */
     creator(creator) {
         this.query.creator = creator;
         return this;
     }
-    // token for pagination
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     *
+     * const appsPage1 = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const appsPage2 = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .nextToken(appsPage1["next-token"])
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(next) {
         this.query.next = next;
         return this;
     }
-    // limit results for pagination
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
     limit(limit) {
         this.query.limit = limit;
         return this;
     }
-    // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const apps = await indexerClient
+     *        .searchForApplications()
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value = true) {
         this.query['include-all'] = value;
         return this;

package/dist/cjs/src/client/v2/indexer/searchForApplications.js.map

@@ -1 +1 @@
-{"version":3,"file":"searchForApplications.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/searchForApplications.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAEzC,MAAqB,qBAAsB,SAAQ,qBAAW;IAC5D,kDAAkD;IAClD,IAAI;QACF,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,oCAAoC;IACpC,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gCAAgC;IAChC,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,uBAAuB;IACvB,SAAS,CAAC,IAAY;QACpB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wJAAwJ;IACxJ,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAnCD,wCAmCC"}
+{"version":3,"file":"searchForApplications.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/searchForApplications.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAEzC;;;;;;;;;;GAUG;AACH,MAAqB,qBAAsB,SAAQ,qBAAW;IAC5D;;OAEG;IACH,kDAAkD;IAClD,IAAI;QACF,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,GAAG,KAAK,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,IAAY;QACpB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAxHD,wCAwHC"}

package/dist/cjs/src/client/v2/indexer/searchForAssets.js

@@ -4,42 +4,167 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const jsonrequest_1 = __importDefault(require("../jsonrequest"));
+/**
+ * Returns information about indexed assets.
+ *
+ * #### Example
+ * ```typescript
+ * const assets = await indexerClient.searchForAssets().do();
+ * ```
+ *
+ * [Response data schema details](https://developer.algorand.org/docs/rest-apis/indexer/#get-v2assets)
+ * @category GET
+ */
 class SearchForAssets extends jsonrequest_1.default {
+    /**
+     * @returns `/v2/assets`
+     */
     // eslint-disable-next-line class-methods-use-this
     path() {
         return '/v2/assets';
     }
-    // limit for filter, as int
+    /**
+     * Limit results for pagination.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .do();
+     * ```
+     *
+     * @param limit - maximum number of results to return.
+     * @category query
+     */
     limit(limit) {
         this.query.limit = limit;
         return this;
     }
-    // asset creator address for filter, as string
+    /**
+     * Filter just assets with the given creator address.
+     *
+     * #### Example
+     * ```typescript
+     * const address = "XBYLS2E6YI6XXL5BWCAMOA4GTWHXWENZMX5UHXMRNWWUQ7BXCY5WC5TEPA";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .creator(address)
+     *        .do();
+     * ```
+     *
+     * @param creator
+     * @category query
+     */
     creator(creator) {
         this.query.creator = creator;
         return this;
     }
-    // asset name for filter, as string
+    /**
+     * Filter just assets with the given name.
+     *
+     * #### Example
+     * ```typescript
+     * const name = "Test Token";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .name(name)
+     *        .do();
+     * ```
+     *
+     * @param name
+     * @category query
+     */
     name(name) {
         this.query.name = name;
         return this;
     }
-    // asset unit name for filter, as string
+    /**
+     * Filter just assets with the given unit.
+     *
+     * #### Example
+     * ```typescript
+     * const unit = "test";
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .unit(unit)
+     *        .do();
+     * ```
+     *
+     * @param unit
+     * @category query
+     */
     unit(unit) {
         this.query.unit = unit;
         return this;
     }
-    // asset ID for filter, as int
+    /**
+     * Asset ID for filter, as int.
+     *
+     * #### Example
+     * ```typescript
+     * const assetId = 163650;
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .index(assetId)
+     *        .do();
+     * ```
+     * @remarks Alternatively, use `indexerClient.lookupAssetByID(assetId).do();`
+     * @param index
+     * @category query
+     */
     index(index) {
         this.query['asset-id'] = index;
         return this;
     }
-    // used for pagination
+    /**
+     * Specify the next page of results.
+     *
+     * #### Example
+     * ```typescript
+     * const maxResults = 20;
+     *
+     * const assetsPage1 = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .do();
+     *
+     * const assetsPage2 = await indexerClient
+     *        .searchForAssets()
+     *        .limit(maxResults)
+     *        .nextToken(assetsPage1["next-token"])
+     *        .do();
+     * ```
+     * @param nextToken - provided by the previous results.
+     * @category query
+     */
     nextToken(nextToken) {
         this.query.next = nextToken;
         return this;
     }
-    // include all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+    /**
+     * Includes all items including closed accounts, deleted applications, destroyed assets, opted-out asset holdings, and closed-out application localstates
+     *
+     * #### Example 1
+     * ```typescript
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .includeAll(false)
+     *        .do();
+     * ```
+     *
+     * #### Example 2
+     * ```typescript
+     * const assets = await indexerClient
+     *        .searchForAssets()
+     *        .includeAll()
+     *        .do();
+     * ```
+     *
+     * @param value - default true when called without passing a value
+     * @category query
+     */
     includeAll(value = true) {
         this.query['include-all'] = value;
         return this;

package/dist/cjs/src/client/v2/indexer/searchForAssets.js.map

@@ -1 +1 @@
-{"version":3,"file":"searchForAssets.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/searchForAssets.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAEzC,MAAqB,eAAgB,SAAQ,qBAAW;IACtD,kDAAkD;IAClD,IAAI;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8CAA8C;IAC9C,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,mCAAmC;IACnC,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wCAAwC;IACxC,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,8BAA8B;IAC9B,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,sBAAsB;IACtB,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,wJAAwJ;IACxJ,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AA/CD,kCA+CC"}
+{"version":3,"file":"searchForAssets.js","sourceRoot":"","sources":["../../../../../../src/client/v2/indexer/searchForAssets.ts"],"names":[],"mappings":";;;;;AAAA,iEAAyC;AAEzC;;;;;;;;;;GAUG;AACH,MAAqB,eAAgB,SAAQ,qBAAW;IACtD;;OAEG;IACH,kDAAkD;IAClD,IAAI;QACF,OAAO,YAAY,CAAC;IACtB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,OAAe;QACrB,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,KAAK,CAAC;QAC/B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,SAAS,CAAC,SAAiB;QACzB,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,UAAU,CAAC,KAAK,GAAG,IAAI;QACrB,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,GAAG,KAAK,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAjKD,kCAiKC"}