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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 5 commits into from
Aug 25, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
30cd65b
feat: increase discoverability of algokit resolve by id and name methods
inaie-makerx Aug 21, 2023
930e28b
fix: generate doc
inaie-makerx Aug 21, 2023
725ec74
fix: pr review
inaie-makerx Aug 23, 2023
b305e2a
fix: pr review
inaie-makerx Aug 25, 2023
e6ab854
chore: minor typo fixes
aorumbayev Aug 25, 2023
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
78 changes: 39 additions & 39 deletions docs/code/classes/types_app_client.ApplicationClient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Create a new ApplicationClient instance

#### Defined in

[src/types/app-client.ts:270](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L270)
[src/types/app-client.ts:289](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L289)

## Properties

Expand All @@ -83,7 +83,7 @@ Create a new ApplicationClient instance

#### Defined in

[src/types/app-client.ts:253](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L253)
[src/types/app-client.ts:272](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L272)

___

Expand All @@ -93,7 +93,7 @@ ___

#### Defined in

[src/types/app-client.ts:252](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L252)
[src/types/app-client.ts:271](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L271)

___

Expand All @@ -103,7 +103,7 @@ ___

#### Defined in

[src/types/app-client.ts:255](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L255)
[src/types/app-client.ts:274](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L274)

___

Expand All @@ -113,7 +113,7 @@ ___

#### Defined in

[src/types/app-client.ts:257](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L257)
[src/types/app-client.ts:276](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L276)

___

Expand All @@ -123,7 +123,7 @@ ___

#### Defined in

[src/types/app-client.ts:258](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L258)
[src/types/app-client.ts:277](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L277)

___

Expand All @@ -133,7 +133,7 @@ ___

#### Defined in

[src/types/app-client.ts:254](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L254)
[src/types/app-client.ts:273](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L273)

___

Expand All @@ -143,7 +143,7 @@ ___

#### Defined in

[src/types/app-client.ts:244](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L244)
[src/types/app-client.ts:263](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L263)

___

Expand All @@ -153,7 +153,7 @@ ___

#### Defined in

[src/types/app-client.ts:246](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L246)
[src/types/app-client.ts:265](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L265)

___

Expand All @@ -163,7 +163,7 @@ ___

#### Defined in

[src/types/app-client.ts:250](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L250)
[src/types/app-client.ts:269](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L269)

___

Expand All @@ -173,7 +173,7 @@ ___

#### Defined in

[src/types/app-client.ts:249](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L249)
[src/types/app-client.ts:268](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L268)

___

Expand All @@ -183,7 +183,7 @@ ___

#### Defined in

[src/types/app-client.ts:245](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L245)
[src/types/app-client.ts:264](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L264)

___

Expand All @@ -193,7 +193,7 @@ ___

#### Defined in

[src/types/app-client.ts:248](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L248)
[src/types/app-client.ts:267](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L267)

___

Expand All @@ -203,7 +203,7 @@ ___

#### Defined in

[src/types/app-client.ts:247](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L247)
[src/types/app-client.ts:266](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L266)

## Methods

Expand All @@ -227,7 +227,7 @@ The result of the call

#### Defined in

[src/types/app-client.ts:563](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L563)
[src/types/app-client.ts:582](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L582)

___

Expand All @@ -252,7 +252,7 @@ The result of the call

#### Defined in

[src/types/app-client.ts:636](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L636)
[src/types/app-client.ts:655](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L655)

___

Expand All @@ -276,7 +276,7 @@ The result of the call

#### Defined in

[src/types/app-client.ts:617](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L617)
[src/types/app-client.ts:636](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L636)

___

Expand All @@ -300,7 +300,7 @@ The result of the call

#### Defined in

[src/types/app-client.ts:608](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L608)
[src/types/app-client.ts:627](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L627)

___

Expand All @@ -324,7 +324,7 @@ The compiled approval and clear programs

#### Defined in

[src/types/app-client.ts:307](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L307)
[src/types/app-client.ts:326](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L326)

___

Expand All @@ -348,7 +348,7 @@ The details of the created app, or the transaction to create it if `skipSending`

#### Defined in

[src/types/app-client.ts:472](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L472)
[src/types/app-client.ts:491](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L491)

___

Expand All @@ -372,7 +372,7 @@ The result of the call

#### Defined in

[src/types/app-client.ts:626](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L626)
[src/types/app-client.ts:645](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L645)

___

Expand Down Expand Up @@ -402,7 +402,7 @@ The metadata and transaction result(s) of the deployment, or just the metadata i

#### Defined in

[src/types/app-client.ts:364](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L364)
[src/types/app-client.ts:383](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L383)

___

Expand All @@ -420,7 +420,7 @@ The source maps

#### Defined in

[src/types/app-client.ts:331](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L331)
[src/types/app-client.ts:350](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L350)

___

Expand All @@ -447,7 +447,7 @@ The new error, or if there was no logic error or source map then the wrapped err

#### Defined in

[src/types/app-client.ts:952](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L952)
[src/types/app-client.ts:971](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L971)

___

Expand All @@ -471,7 +471,7 @@ The result of the funding

#### Defined in

[src/types/app-client.ts:676](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L676)
[src/types/app-client.ts:695](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L695)

___

Expand All @@ -495,7 +495,7 @@ The ABI method for the given method

#### Defined in

[src/types/app-client.ts:911](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L911)
[src/types/app-client.ts:930](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L930)

___

Expand All @@ -519,7 +519,7 @@ The ABI method params for the given method

#### Defined in

[src/types/app-client.ts:889](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L889)
[src/types/app-client.ts:908](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L908)

___

Expand All @@ -538,7 +538,7 @@ The app reference, or if deployed using the `deploy` method, the app metadata to

#### Defined in

[src/types/app-client.ts:921](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L921)
[src/types/app-client.ts:940](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L940)

___

Expand All @@ -556,7 +556,7 @@ The names of the boxes

#### Defined in

[src/types/app-client.ts:730](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L730)
[src/types/app-client.ts:749](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L749)

___

Expand All @@ -580,7 +580,7 @@ The current box value as a byte array

#### Defined in

[src/types/app-client.ts:745](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L745)
[src/types/app-client.ts:764](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L764)

___

Expand All @@ -605,7 +605,7 @@ The current box value as a byte array

#### Defined in

[src/types/app-client.ts:761](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L761)
[src/types/app-client.ts:780](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L780)

___

Expand All @@ -630,7 +630,7 @@ The (name, value) pair of the boxes with values as raw byte arrays

#### Defined in

[src/types/app-client.ts:777](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L777)
[src/types/app-client.ts:796](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L796)

___

Expand All @@ -656,7 +656,7 @@ The (name, value) pair of the boxes with values as the ABI Value

#### Defined in

[src/types/app-client.ts:799](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L799)
[src/types/app-client.ts:818](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L818)

___

Expand All @@ -681,7 +681,7 @@ The call args ready to pass into an app call

#### Defined in

[src/types/app-client.ts:821](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L821)
[src/types/app-client.ts:840](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L840)

___

Expand All @@ -699,7 +699,7 @@ The global state

#### Defined in

[src/types/app-client.ts:702](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L702)
[src/types/app-client.ts:721](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L721)

___

Expand All @@ -723,7 +723,7 @@ The global state

#### Defined in

[src/types/app-client.ts:716](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L716)
[src/types/app-client.ts:735](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L735)

___

Expand All @@ -745,7 +745,7 @@ Import source maps for the app.

#### Defined in

[src/types/app-client.ts:348](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L348)
[src/types/app-client.ts:367](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L367)

___

Expand All @@ -769,7 +769,7 @@ The result of the call

#### Defined in

[src/types/app-client.ts:599](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L599)
[src/types/app-client.ts:618](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L618)

___

Expand All @@ -793,4 +793,4 @@ The transaction send result and the compilation result

#### Defined in

[src/types/app-client.ts:524](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L524)
[src/types/app-client.ts:543](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L543)
2 changes: 1 addition & 1 deletion docs/code/interfaces/types_app_client.AppClientCallABIArgs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ If calling an ABI method then either the name of the method, or the ABI signatur

#### Defined in

[src/types/app-client.ts:145](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L145)
[src/types/app-client.ts:164](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L164)

___

Expand Down
6 changes: 3 additions & 3 deletions docs/code/interfaces/types_app_client.AppClientCallCoreParams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The transaction note for the smart contract call

#### Defined in

[src/types/app-client.ts:156](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L156)
[src/types/app-client.ts:175](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L175)

___

Expand All @@ -36,7 +36,7 @@ Parameters to control transaction sending

#### Defined in

[src/types/app-client.ts:158](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L158)
[src/types/app-client.ts:177](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L177)

___

Expand All @@ -48,4 +48,4 @@ The optional sender to send the transaction from, will use the application clien

#### Defined in

[src/types/app-client.ts:154](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L154)
[src/types/app-client.ts:173](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/app-client.ts#L173)
Loading
Loading