Skip to content

Commit b892c8a

Browse files
author
Kevin Busch
committed
0.3.3
1 parent fc06913 commit b892c8a

32 files changed

+643
-578
lines changed

docs/README.md

Lines changed: 336 additions & 327 deletions
Large diffs are not rendered by default.

docs/classes/do.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ the Do.catch method takes a callback where the parameters are:
4545

4646
\+ **new Do**(`workload`: [AsyncWorkload](../README.md#asyncworkload)‹TReturnVal›): *[Do](do.md)*
4747

48-
*Defined in [src/utilities/do-try.ts:23](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L23)*
48+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:23
4949

5050
**Parameters:**
5151

@@ -61,15 +61,15 @@ Name | Type |
6161

6262
**promise**: *Promise‹TReturnVal›*
6363

64-
*Defined in [src/utilities/do-try.ts:19](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L19)*
64+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:19
6565

6666
## Methods
6767

6868
### catch
6969

7070
**catch**(`errorHandler`: [CatchResultHandler](../README.md#catchresulthandler)‹TResourceType›): *[Do](do.md)‹TResourceType, TReturnVal›*
7171

72-
*Defined in [src/utilities/do-try.ts:46](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L46)*
72+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:46
7373

7474
Handle errors from the workload.
7575
If errors are in the shape of a {ResultRecord},
@@ -93,7 +93,7 @@ ___
9393

9494
**finally**(`finallyHandler`: [FinallyHandler](../README.md#finallyhandler)): *[Do](do.md)‹TResourceType, TReturnVal›*
9595

96-
*Defined in [src/utilities/do-try.ts:75](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L75)*
96+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:75
9797

9898
Run some handler when the function completes, whether the
9999
catch() was hit or not.
@@ -114,7 +114,7 @@ ___
114114

115115
**getAwaiter**(): *Promise‹TReturnVal›*
116116

117-
*Defined in [src/utilities/do-try.ts:89](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L89)*
117+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:89
118118

119119
Awaits the internal promise being tracked by the Do instance,
120120
and returns the result. This way, you can await a Do.try
@@ -131,7 +131,7 @@ ___
131131

132132
**configure**(`config`: [DoTryConfig](../interfaces/dotryconfig.md)): *void*
133133

134-
*Defined in [src/utilities/do-try.ts:65](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L65)*
134+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:65
135135

136136
Sets the global configuration object for class {Do}
137137

@@ -149,7 +149,7 @@ ___
149149

150150
**try**<**TResourceType**, **TReturnVal**>(`workload`: [AsyncWorkload](../README.md#asyncworkload)‹TReturnVal›): *[Do](do.md)‹TResourceType, TReturnVal›*
151151

152-
*Defined in [src/utilities/do-try.ts:100](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L100)*
152+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:100
153153

154154
Static factory method for Do class.
155155
Start a workload (sync or async) that you can then
@@ -177,10 +177,10 @@ a new instance of Do
177177

178178
### **config**: *object*
179179

180-
*Defined in [src/utilities/do-try.ts:21](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L21)*
180+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:21
181181

182182
### defaultErrorHandler
183183

184184
**defaultErrorHandler**: *undefined* = undefined
185185

186-
*Defined in [src/utilities/do-try.ts:22](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L22)*
186+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:22

docs/classes/dosync.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242

4343
\+ **new DoSync**(`workload`: [SyncWorkload](../README.md#syncworkload)‹TReturnVal›): *[DoSync](dosync.md)*
4444

45-
*Defined in [src/utilities/do-try.ts:120](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L120)*
45+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:120
4646

4747
**Parameters:**
4848

@@ -58,31 +58,31 @@ Name | Type |
5858

5959
**catchHandler**? : *undefined | function*
6060

61-
*Defined in [src/utilities/do-try.ts:115](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L115)*
61+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:115
6262

6363
___
6464

6565
### `Private` `Optional` finallyHandler
6666

6767
**finallyHandler**? : *[FinallyHandler](../README.md#finallyhandler)*
6868

69-
*Defined in [src/utilities/do-try.ts:116](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L116)*
69+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:116
7070

7171
___
7272

7373
### `Private` `Readonly` workload
7474

7575
**workload**: *[SyncWorkload](../README.md#syncworkload)‹TReturnVal›*
7676

77-
*Defined in [src/utilities/do-try.ts:114](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L114)*
77+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:114
7878

7979
## Methods
8080

8181
### catch
8282

8383
**catch**(`errorHandler`: [CatchResultHandler](../README.md#catchresulthandler)‹TResourceType›): *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
8484

85-
*Defined in [src/utilities/do-try.ts:134](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L134)*
85+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:134
8686

8787
Add a catch handler to the DoSync call chain.
8888
If errors are in the shape of a {ResultRecord},
@@ -104,7 +104,7 @@ ___
104104

105105
**execute**(): *TReturnVal | undefined*
106106

107-
*Defined in [src/utilities/do-try.ts:162](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L162)*
107+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:162
108108

109109
Execute the entire DoSync call chain. For the synchronous version, i.e. DoSync,
110110
you must manually call .execute() for the call chain to be executed.
@@ -119,7 +119,7 @@ ___
119119

120120
**finally**(`finallyHandler`: [FinallyHandler](../README.md#finallyhandler)): *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
121121

122-
*Defined in [src/utilities/do-try.ts:185](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L185)*
122+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:185
123123

124124
Run some handler when the function completes, whether the
125125
catch() was hit or not.
@@ -140,7 +140,7 @@ ___
140140

141141
**configure**(`config`: [DoTryConfig](../interfaces/dotryconfig.md)): *void*
142142

143-
*Defined in [src/utilities/do-try.ts:153](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L153)*
143+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:153
144144

145145
Sets the global configuration for class {DySync}.
146146

@@ -158,7 +158,7 @@ ___
158158

159159
**try**<**TResourceType**, **TReturnVal**>(`workload`: [SyncWorkload](../README.md#syncworkload)‹TReturnVal›): *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
160160

161-
*Defined in [src/utilities/do-try.ts:197](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L197)*
161+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:197
162162

163163
Static factory method for DoSync. Creates a new DoSync
164164
with the given workload.
@@ -183,10 +183,10 @@ Name | Type | Description |
183183

184184
### **config**: *object*
185185

186-
*Defined in [src/utilities/do-try.ts:118](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L118)*
186+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:118
187187

188188
### defaultErrorHandler
189189

190190
**defaultErrorHandler**: *undefined* = undefined
191191

192-
*Defined in [src/utilities/do-try.ts:119](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L119)*
192+
Defined in clients/andculture/kevinbusch-AndcultureCode.JavaScript.Core/src/utilities/do-try.ts:119

0 commit comments

Comments
 (0)