Skip to content

Commit bbb97bd

Browse files
authored
fix: refine js docs (#379)
* fix: refine js docs * chore: fix audit issues
1 parent ebd3e6d commit bbb97bd

File tree

49 files changed

+3595
-1105
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+3595
-1105
lines changed

docs/code/classes/types_account.MultisigAccount.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Account wrapper that supports partial or full multisig signing.
4949

5050
#### Defined in
5151

52-
[src/types/account.ts:45](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L45)
52+
[src/types/account.ts:46](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L46)
5353

5454
## Properties
5555

@@ -129,13 +129,15 @@ ___
129129

130130
`get` **signer**(): `TransactionSigner`
131131

132+
The transaction signer for the multisig account
133+
132134
#### Returns
133135

134136
`TransactionSigner`
135137

136138
#### Defined in
137139

138-
[src/types/account.ts:41](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L41)
140+
[src/types/account.ts:42](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L42)
139141

140142
___
141143

@@ -173,6 +175,12 @@ Sign the given transaction
173175

174176
The transaction signed by the present signers
175177

178+
**`Example`**
179+
180+
```typescript
181+
const signedTxn = multisigAccount.sign(myTransaction)
182+
```
183+
176184
#### Defined in
177185

178-
[src/types/account.ts:60](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L60)
186+
[src/types/account.ts:65](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L65)

docs/code/classes/types_account.SigningAccount.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Account wrapper that supports a rekeyed account
4848

4949
#### Defined in
5050

51-
[src/types/account.ts:110](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L110)
51+
[src/types/account.ts:115](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L115)
5252

5353
## Properties
5454

@@ -58,7 +58,7 @@ Account wrapper that supports a rekeyed account
5858

5959
#### Defined in
6060

61-
[src/types/account.ts:75](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L75)
61+
[src/types/account.ts:80](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L80)
6262

6363
___
6464

@@ -68,7 +68,7 @@ ___
6868

6969
#### Defined in
7070

71-
[src/types/account.ts:77](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L77)
71+
[src/types/account.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L82)
7272

7373
___
7474

@@ -78,7 +78,7 @@ ___
7878

7979
#### Defined in
8080

81-
[src/types/account.ts:76](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L76)
81+
[src/types/account.ts:81](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L81)
8282

8383
## Accessors
8484

@@ -98,7 +98,7 @@ Account.addr
9898

9999
#### Defined in
100100

101-
[src/types/account.ts:82](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L82)
101+
[src/types/account.ts:87](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L87)
102102

103103
___
104104

@@ -114,7 +114,7 @@ Algorand account of the sender address and signer private key
114114

115115
#### Defined in
116116

117-
[src/types/account.ts:103](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L103)
117+
[src/types/account.ts:108](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L108)
118118

119119
___
120120

@@ -130,7 +130,7 @@ Transaction signer for the underlying signing account
130130

131131
#### Defined in
132132

133-
[src/types/account.ts:96](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L96)
133+
[src/types/account.ts:101](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L101)
134134

135135
___
136136

@@ -150,4 +150,4 @@ Account.sk
150150

151151
#### Defined in
152152

153-
[src/types/account.ts:89](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L89)
153+
[src/types/account.ts:94](https://github.com/algorandfoundation/algokit-utils-ts/blob/main/src/types/account.ts#L94)

0 commit comments

Comments
 (0)