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

fix: increase discoverability of algokit resolve by id and name methods #108

Merged
merged 5 commits into from
Aug 25, 2023

Conversation

src/app-client.ts Outdated Show resolved Hide resolved
src/app-client.ts Show resolved Hide resolved
* @param deployTimeParams Optionally provide any deploy-time parameters to replace in the TEAL code; if specified here will get used in calls to `deploy`, `create` and `update` unless overridden in those calls
* @param name The optional name to use to mark the app when deploying `ApplicationClient.deploy` (default: uses the name in the ABI contract)
*
* @returns The application client
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we also add a set of example docstrings for valid simple and copy-pasteable example invocation for getAppClientById, getAppClientByCreatorAndName and for getAppClient as well?

@aorumbayev
Copy link
Contributor

@inaie-makerx as discussed, a few more tweaks needed:

  • Improve parameters handling to not require users to explicitly pass resolveBy parameter if they are calling those helper methods
  • Add extra example to generic getAppClient also showcasing how to pass different params for resolve by id vs by creator and name

@robdmoore
Copy link
Contributor

Good catch on resolveBy, definitely want to exclude that from being needed

@aorumbayev aorumbayev self-requested a review August 25, 2023 08:38
@aorumbayev aorumbayev changed the title feat: increase discoverability of algokit resolve by id and name methods fix: increase discoverability of algokit resolve by id and name methods Aug 25, 2023
@aorumbayev aorumbayev merged commit f5289b9 into main Aug 25, 2023
2 checks passed
@aorumbayev aorumbayev deleted the increase-discoverability-algokit branch August 25, 2023 08:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants