Skip to content
This repository has been archived by the owner on Jun 3, 2022. It is now read-only.

Commit

Permalink
update jsdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
canonbrother committed May 6, 2022
1 parent b51dbf7 commit 1a61b6a
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions packages/whale-api-client/src/api/address.ts
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,8 @@ export class Address {
* List all tokens balance belonging to an address.
*
* @param {string} address bech32/legacy/b58 formatted address
* @param {number} size to query
* @param {number} next token for next slice of AddressToken
* @param {number} [size=30] to query
* @param {number} [next] token for next slice of AddressToken
* @return {Promise<ApiPagedResponse<AddressToken>>}
*/
async listToken (address: string, size: number = 30, next?: string): Promise<ApiPagedResponse<AddressToken>> {
Expand All @@ -70,8 +70,8 @@ export class Address {
* List all vaults belonging to an address.
*
* @param {string} address bech32/legacy/b58 formatted address
* @param {number} size of vaults to query
* @param {string} next set of vaults
* @param {number} [size=30] of vaults to query
* @param {string} [next] set of vaults
* @return {Promise<ApiPagedResponse<LoanVaultActive | LoanVaultLiquidated>>}
*/
async listVault (address: string, size: number = 30, next?: string): Promise<ApiPagedResponse<LoanVaultActive | LoanVaultLiquidated>> {
Expand All @@ -82,8 +82,8 @@ export class Address {
* List all transaction activity belonging to an address.
*
* @param {string} address bech32/legacy/b58 formatted address
* @param {number} size to query
* @param {number} next token for next slice of AddressActivity
* @param {number} [size=30] to query
* @param {number} [next] token for next slice of AddressActivity
* @return {Promise<ApiPagedResponse<AddressActivity>>}
*/
async listTransaction (address: string, size: number = 30, next?: string): Promise<ApiPagedResponse<AddressActivity>> {
Expand All @@ -94,8 +94,8 @@ export class Address {
* List all unspent belonging to an address.
*
* @param {string} address bech32/legacy/b58 formatted address
* @param {number} size to query
* @param {number} next token for next slice of AddressUnspent
* @param {number} [size=30] to query
* @param {number} [next] token for next slice of AddressUnspent
* @return {Promise<ApiPagedResponse<AddressUnspent>>}
*/
async listTransactionUnspent (address: string, size: number = 30, next?: string): Promise<ApiPagedResponse<AddressUnspent>> {
Expand All @@ -107,8 +107,8 @@ export class Address {
*
* @param {string} address to list future swap
* @param {number} height to set range of future swap
* @param {string} size to query
* @param {string} next token for next slice of FutureSwap
* @param {string} [size=30] to query
* @param {string} [next] token for next slice of FutureSwap
* @return {Promise<ApiPagedResponse<FutureSwap>>}
*/
async listFutureSwap (address: string, height: number, size: number = 30, next?: string): Promise<ApiPagedResponse<FutureSwap>> {
Expand Down

0 comments on commit 1a61b6a

Please sign in to comment.