0.2.3

Author: Brandon Scott

docs/README.md

@@ -32,15 +32,20 @@ the Do.catch method takes a callback where the parameters are:
 * [catch](do.md#catch)
 * [finally](do.md#finally)
 * [getAwaiter](do.md#getawaiter)
+* [configure](do.md#static-configure)
 * [try](do.md#static-try)
 
+### Object literals
+
+* [config](do.md#static-private-config)
+
 ## Constructors
 
 ### `Private` constructor
 
 \+ **new Do**(`workload`: [AsyncWorkload](../README.md#asyncworkload)‹TReturnVal›): *[Do](do.md)*
 
-*Defined in [src/utilities/do-try.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L20)*
+*Defined in [src/utilities/do-try.ts:23](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L23)*
 
 **Parameters:**
 
@@ -56,15 +61,15 @@ Name | Type |
 
 • **promise**: *Promise‹TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:20](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L20)*
+*Defined in [src/utilities/do-try.ts:19](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L19)*
 
 ## Methods
 
 ###  catch
 
-▸ **catch**(`errorHandler`: [CatchHandler](../README.md#catchhandler)‹TResourceType›): *[Do](do.md)‹TResourceType, TReturnVal›*
+▸ **catch**(`errorHandler`: [CatchResultHandler](../README.md#catchresulthandler)‹TResourceType›): *[Do](do.md)‹TResourceType, TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:35](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L35)*
+*Defined in [src/utilities/do-try.ts:46](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L46)*
 
 Handle errors from the workload.
 If errors are in the shape of a {ResultRecord},
@@ -76,7 +81,7 @@ you'll get an {any} as the second parameter.
 
 Name | Type | Description |
 ------ | ------ | ------ |
-`errorHandler` | [CatchHandler](../README.md#catchhandler)‹TResourceType› | handle errors, either as a {ResultRecord} or {any} |
+`errorHandler` | [CatchResultHandler](../README.md#catchresulthandler)‹TResourceType› | handle errors, either as a {ResultRecord} or {any} |
 
 **Returns:** *[Do](do.md)‹TResourceType, TReturnVal›*
 
@@ -88,7 +93,7 @@ ___
 
 ▸ **finally**(`finallyHandler`: [FinallyHandler](../README.md#finallyhandler)): *[Do](do.md)‹TResourceType, TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:56](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L56)*
+*Defined in [src/utilities/do-try.ts:75](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L75)*
 
 Run some handler when the function completes, whether the
 catch() was hit or not.
@@ -109,7 +114,7 @@ ___
 
 ▸ **getAwaiter**(): *Promise‹TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:70](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L70)*
+*Defined in [src/utilities/do-try.ts:89](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L89)*
 
 Awaits the internal promise being tracked by the Do instance,
 and returns the result. This way, you can await a Do.try
@@ -122,11 +127,29 @@ the result of the promise.
 
 ___
 
+### `Static` configure
+
+▸ **configure**(`config`: [DoTryConfig](../interfaces/dotryconfig.md)): *void*
+
+*Defined in [src/utilities/do-try.ts:65](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L65)*
+
+Sets the global configuration object for class {Do}
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`config` | [DoTryConfig](../interfaces/dotryconfig.md) | the {DoTryConfig} object to set  |
+
+**Returns:** *void*
+
+___
+
 ### `Static` try
 
 ▸ **try**<**TResourceType**, **TReturnVal**>(`workload`: [AsyncWorkload](../README.md#asyncworkload)‹TReturnVal›): *[Do](do.md)‹TResourceType, TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:81](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L81)*
+*Defined in [src/utilities/do-try.ts:100](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L100)*
 
 Static factory method for Do class.
 Start a workload (sync or async) that you can then
@@ -147,3 +170,17 @@ Name | Type | Description |
 **Returns:** *[Do](do.md)‹TResourceType, TReturnVal›*
 
 a new instance of Do
+
+## Object literals
+
+### `Static` `Private` config
+
+### ▪ **config**: *object*
+
+*Defined in [src/utilities/do-try.ts:21](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L21)*
+
+###  defaultErrorHandler
+
+• **defaultErrorHandler**: *undefined* = undefined
+
+*Defined in [src/utilities/do-try.ts:22](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L22)*

docs/classes/do.md

@@ -29,15 +29,20 @@
 * [catch](dosync.md#catch)
 * [execute](dosync.md#execute)
 * [finally](dosync.md#finally)
+* [configure](dosync.md#static-configure)
 * [try](dosync.md#static-try)
 
+### Object literals
+
+* [config](dosync.md#static-private-config)
+
 ## Constructors
 
 ### `Private` constructor
 
 \+ **new DoSync**(`workload`: [SyncWorkload](../README.md#syncworkload)‹TReturnVal›): *[DoSync](dosync.md)*
 
-*Defined in [src/utilities/do-try.ts:97](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L97)*
+*Defined in [src/utilities/do-try.ts:120](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L120)*
 
 **Parameters:**
 
@@ -53,31 +58,31 @@ Name | Type |
 
 • **catchHandler**? : *undefined | function*
 
-*Defined in [src/utilities/do-try.ts:96](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L96)*
+*Defined in [src/utilities/do-try.ts:115](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L115)*
 
 ___
 
 ### `Private` `Optional` finallyHandler
 
 • **finallyHandler**? : *[FinallyHandler](../README.md#finallyhandler)*
 
-*Defined in [src/utilities/do-try.ts:97](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L97)*
+*Defined in [src/utilities/do-try.ts:116](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L116)*
 
 ___
 
 ### `Private` `Readonly` workload
 
 • **workload**: *[SyncWorkload](../README.md#syncworkload)‹TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:95](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L95)*
+*Defined in [src/utilities/do-try.ts:114](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L114)*
 
 ## Methods
 
 ###  catch
 
-▸ **catch**(`errorHandler`: [CatchHandler](../README.md#catchhandler)‹TResourceType›): *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
+▸ **catch**(`errorHandler`: [CatchResultHandler](../README.md#catchresulthandler)‹TResourceType›): *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:111](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L111)*
+*Defined in [src/utilities/do-try.ts:134](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L134)*
 
 Add a catch handler to the DoSync call chain.
 If errors are in the shape of a {ResultRecord},
@@ -89,7 +94,7 @@ you'll get an {any} as the second parameter.
 
 Name | Type | Description |
 ------ | ------ | ------ |
-`errorHandler` | [CatchHandler](../README.md#catchhandler)‹TResourceType› | handle errors, either as a {ResultRecord} or {any}  |
+`errorHandler` | [CatchResultHandler](../README.md#catchresulthandler)‹TResourceType› | handle errors, either as a {ResultRecord} or {any}  |
 
 **Returns:** *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
 
@@ -99,7 +104,7 @@ ___
 
 ▸ **execute**(): *TReturnVal | undefined*
 
-*Defined in [src/utilities/do-try.ts:131](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L131)*
+*Defined in [src/utilities/do-try.ts:162](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L162)*
 
 Execute the entire DoSync call chain. For the synchronous version, i.e. DoSync,
 you must manually call .execute() for the call chain to be executed.
@@ -114,7 +119,7 @@ ___
 
 ▸ **finally**(`finallyHandler`: [FinallyHandler](../README.md#finallyhandler)): *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:147](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L147)*
+*Defined in [src/utilities/do-try.ts:185](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L185)*
 
 Run some handler when the function completes, whether the
 catch() was hit or not.
@@ -131,11 +136,29 @@ this
 
 ___
 
+### `Static` configure
+
+▸ **configure**(`config`: [DoTryConfig](../interfaces/dotryconfig.md)): *void*
+
+*Defined in [src/utilities/do-try.ts:153](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L153)*
+
+Sets the global configuration for class {DySync}.
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`config` | [DoTryConfig](../interfaces/dotryconfig.md) | the {DoTryConfig} object to set  |
+
+**Returns:** *void*
+
+___
+
 ### `Static` try
 
 ▸ **try**<**TResourceType**, **TReturnVal**>(`workload`: [SyncWorkload](../README.md#syncworkload)‹TReturnVal›): *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
 
-*Defined in [src/utilities/do-try.ts:159](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/utilities/do-try.ts#L159)*
+*Defined in [src/utilities/do-try.ts:197](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L197)*
 
 Static factory method for DoSync. Creates a new DoSync
 with the given workload.
@@ -153,3 +176,17 @@ Name | Type | Description |
 `workload` | [SyncWorkload](../README.md#syncworkload)‹TReturnVal› |   |
 
 **Returns:** *[DoSync](dosync.md)‹TResourceType, TReturnVal›*
+
+## Object literals
+
+### `Static` `Private` config
+
+### ▪ **config**: *object*
+
+*Defined in [src/utilities/do-try.ts:118](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L118)*
+
+###  defaultErrorHandler
+
+• **defaultErrorHandler**: *undefined* = undefined
+
+*Defined in [src/utilities/do-try.ts:119](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/utilities/do-try.ts#L119)*

docs/classes/dosync.md

@@ -157,7 +157,7 @@ The name provided to `Record(values, name)` can be accessed with
 
 \+ **new ResultErrorRecord**(`params?`: [ResultError](../interfaces/resulterror.md)): *[ResultErrorRecord](resulterrorrecord.md)*
 
-*Defined in [src/view-models/result-error-record.ts:11](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-error-record.ts#L11)*
+*Defined in [src/view-models/result-error-record.ts:11](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-error-record.ts#L11)*
 
 **Parameters:**
 
@@ -293,7 +293,7 @@ ___
 
 ▸ **fullError**(): *string*
 
-*Defined in [src/view-models/result-error-record.ts:40](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-error-record.ts#L40)*
+*Defined in [src/view-models/result-error-record.ts:40](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-error-record.ts#L40)*
 
 Display error key and message
 
@@ -759,7 +759,7 @@ ___
 
 ▸ **with**(`values`: Partial‹[ResultError](../interfaces/resulterror.md)›): *[ResultErrorRecord](resulterrorrecord.md)*
 
-*Defined in [src/view-models/result-error-record.ts:51](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-error-record.ts#L51)*
+*Defined in [src/view-models/result-error-record.ts:51](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-error-record.ts#L51)*
 
 Merges new values into the record and returns a new instance.
 

docs/classes/resulterrorrecord.md

@@ -168,7 +168,7 @@ The name provided to `Record(values, name)` can be accessed with
 
 \+ **new ResultRecord**(`params?`: [Result](../interfaces/result.md)‹T›): *[ResultRecord](resultrecord.md)*
 
-*Defined in [src/view-models/result-record.ts:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L13)*
+*Defined in [src/view-models/result-record.ts:13](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L13)*
 
 **Parameters:**
 
@@ -196,7 +196,7 @@ ___
 
 ▸ **_addErrorByType**(`key`: string, `message`: string, `errorType`: [ErrorType](../enums/errortype.md)): *[ResultRecord](resultrecord.md)‹T›*
 
-*Defined in [src/view-models/result-record.ts:151](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L151)*
+*Defined in [src/view-models/result-record.ts:151](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L151)*
 
 **Parameters:**
 
@@ -214,7 +214,7 @@ ___
 
 ▸ **addError**(`key`: string, `message`: string): *[ResultRecord](resultrecord.md)‹T›*
 
-*Defined in [src/view-models/result-record.ts:48](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L48)*
+*Defined in [src/view-models/result-record.ts:48](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L48)*
 
 Adds a new error with the supplied details and returns a new ResultRecord
 
@@ -233,7 +233,7 @@ ___
 
 ▸ **addValidationError**(`key`: string, `message`: string): *[ResultRecord](resultrecord.md)‹T›*
 
-*Defined in [src/view-models/result-record.ts:58](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L58)*
+*Defined in [src/view-models/result-record.ts:58](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L58)*
 
 Adds a new validation error with the supplied details and returns a new ResultRecord
 
@@ -342,7 +342,7 @@ ___
 
 ▸ **doesNotHaveErrors**(): *boolean*
 
-*Defined in [src/view-models/result-record.ts:65](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L65)*
+*Defined in [src/view-models/result-record.ts:65](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L65)*
 
 Evaluates whether there are any errors on the result
 
@@ -372,7 +372,7 @@ ___
 
 ▸ **errorCount**(): *number*
 
-*Defined in [src/view-models/result-record.ts:72](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L72)*
+*Defined in [src/view-models/result-record.ts:72](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L72)*
 
 Returns total number of errors
 
@@ -433,7 +433,7 @@ ___
 
 ▸ **getErrorMessageFor**(`key`: string): *string | undefined*
 
-*Defined in [src/view-models/result-record.ts:84](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L84)*
+*Defined in [src/view-models/result-record.ts:84](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L84)*
 
 Returns an error message for a given key
 
@@ -487,7 +487,7 @@ ___
 
 ▸ **hasErrorFor**(...`keys`: string[]): *boolean*
 
-*Defined in [src/view-models/result-record.ts:92](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L92)*
+*Defined in [src/view-models/result-record.ts:92](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L92)*
 
 Determines if the result contains an error for the supplied key(s)
 
@@ -505,7 +505,7 @@ ___
 
 ▸ **hasErrors**(): *boolean*
 
-*Defined in [src/view-models/result-record.ts:105](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L105)*
+*Defined in [src/view-models/result-record.ts:105](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L105)*
 
 Evaluates whether there are any errors on the result
 
@@ -547,7 +547,7 @@ ___
 
 ▸ **listErrorMessages**(): *string[]*
 
-*Defined in [src/view-models/result-record.ts:123](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L123)*
+*Defined in [src/view-models/result-record.ts:123](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L123)*
 
 Map all error messages into a simple string array.
 
@@ -559,7 +559,7 @@ ___
 
 ▸ **listErrors**(): *string[]*
 
-*Defined in [src/view-models/result-record.ts:112](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L112)*
+*Defined in [src/view-models/result-record.ts:112](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L112)*
 
 Map all errors into simple string array
 
@@ -910,7 +910,7 @@ ___
 
 ▸ **with**(`values`: Partial‹[Result](../interfaces/result.md)‹T››): *[ResultRecord](resultrecord.md)‹T›*
 
-*Defined in [src/view-models/result-record.ts:141](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/0b0f3de/src/view-models/result-record.ts#L141)*
+*Defined in [src/view-models/result-record.ts:141](https://github.com/AndcultureCode/AndcultureCode.JavaScript.Core/blob/ca11227/src/view-models/result-record.ts#L141)*
 
 Merges new values into the record and returns a new instance.