Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: JSDoc parameter names in account_call_builder.ts for clarity #879

Merged
merged 1 commit into from
Nov 10, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/horizon/account_call_builder.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ export class AccountCallBuilder extends CallBuilder<
/**
* This endpoint filters accounts by signer account.
* @see [Accounts](https://developers.stellar.org/api/resources/accounts/list/)
* @param {string} value For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
* @param {string} id For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
* @returns {AccountCallBuilder} current AccountCallBuilder instance
*/
public forSigner(id: string): this {
Expand All @@ -49,7 +49,7 @@ export class AccountCallBuilder extends CallBuilder<
* This endpoint filters all accounts who are trustees to an asset.
* @see [Accounts](https://developers.stellar.org/api/resources/accounts/list/)
* @see Asset
* @param {Asset} value For example: `new Asset('USD','GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD')`
* @param {Asset} asset For example: `new Asset('USD','GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD')`
* @returns {AccountCallBuilder} current AccountCallBuilder instance
*/
public forAsset(asset: Asset): this {
Expand All @@ -60,7 +60,7 @@ export class AccountCallBuilder extends CallBuilder<
/**
* This endpoint filters accounts where the given account is sponsoring the account or any of its sub-entries..
* @see [Accounts](https://developers.stellar.org/api/resources/accounts/list/)
* @param {string} value For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
* @param {string} id For example: `GDGQVOKHW4VEJRU2TETD6DBRKEO5ERCNF353LW5WBFW3JJWQ2BRQ6KDD`
* @returns {AccountCallBuilder} current AccountCallBuilder instance
*/
public sponsor(id: string): this {
Expand All @@ -78,4 +78,4 @@ export class AccountCallBuilder extends CallBuilder<
this.url.setQuery("liquidity_pool", id);
return this;
}
}
}
Loading