@genesislcap/foundation-utils 14.408.0 → 14.409.0

package/docs/api/foundation-utils.default_user.md

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DEFAULT\_USER](./foundation-utils.default_user.md)
-
-## DEFAULT\_USER variable
-
-The default Username value, used in auth/login flow \[`genesislcap-foundation-login`<!-- -->\](https://link-to-docs).
-
-**Signature:**
-
-```typescript
-_DEFAULT_USER: string
-```
-
-## Remarks
-
-Optional.
-

package/docs/api/foundation-utils.defaulterrormap._constructor_.md

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [(constructor)](./foundation-utils.defaulterrormap._constructor_.md)
-
-## DefaultErrorMap.(constructor)
-
-Constructs a new instance of the `DefaultErrorMap` class
-
-**Signature:**
-
-```typescript
-constructor(logger: ErrorMapLogger);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-logger
-
-
-</td><td>
-
-[ErrorMapLogger](./foundation-utils.errormaplogger.md)
-
-
-</td><td>
-
-A logger error method reference.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-utils.defaulterrormap.clear.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [clear](./foundation-utils.defaulterrormap.clear.md)
-
-## DefaultErrorMap.clear() method
-
-Clear errors.
-
-**Signature:**
-
-```typescript
-clear(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-utils.defaulterrormap.delete.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [delete](./foundation-utils.defaulterrormap.delete.md)
-
-## DefaultErrorMap.delete() method
-
-Delete an error.
-
-**Signature:**
-
-```typescript
-delete(key: keyof TErrorDetailMap): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-keyof TErrorDetailMap
-
-
-</td><td>
-
-The key.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-True if successful, otherwise false.
-

package/docs/api/foundation-utils.defaulterrormap.get.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [get](./foundation-utils.defaulterrormap.get.md)
-
-## DefaultErrorMap.get() method
-
-Get an error by key.
-
-**Signature:**
-
-```typescript
-get(key: keyof TErrorDetailMap): Error | undefined;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-keyof TErrorDetailMap
-
-
-</td><td>
-
-The key.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Error \| undefined
-
-The error if it exists, otherwise undefined.
-

package/docs/api/foundation-utils.defaulterrormap.has.md

@@ -1,56 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [has](./foundation-utils.defaulterrormap.has.md)
-
-## DefaultErrorMap.has() method
-
-Has an error for key.
-
-**Signature:**
-
-```typescript
-has(key: keyof TErrorDetailMap): boolean;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-keyof TErrorDetailMap
-
-
-</td><td>
-
-The key.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-boolean
-
-True if it exists, otherwise false.
-

package/docs/api/foundation-utils.defaulterrormap.lasterror.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [lastError](./foundation-utils.defaulterrormap.lasterror.md)
-
-## DefaultErrorMap.lastError property
-
-The last set error if any.
-
-**Signature:**
-
-```typescript
-lastError: Error;
-```

package/docs/api/foundation-utils.defaulterrormap.md

@@ -1,237 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md)
-
-## DefaultErrorMap class
-
-
-**Signature:**
-
-```typescript
-export declare class DefaultErrorMap<TErrorDetailMap extends ErrorDetailMap> implements ErrorMap<TErrorDetailMap> 
-```
-**Implements:** [ErrorMap](./foundation-utils.errormap.md)<!-- -->&lt;TErrorDetailMap&gt;
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(logger)](./foundation-utils.defaulterrormap._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `DefaultErrorMap` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[lastError](./foundation-utils.defaulterrormap.lasterror.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Error
-
-
-</td><td>
-
-The last set error if any.
-
-
-</td></tr>
-<tr><td>
-
-[messages](./foundation-utils.defaulterrormap.messages.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Error map as messages.
-
-
-</td></tr>
-<tr><td>
-
-[size](./foundation-utils.defaulterrormap.size.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-The size of the error map.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[clear()](./foundation-utils.defaulterrormap.clear.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Clear errors.
-
-
-</td></tr>
-<tr><td>
-
-[delete(key)](./foundation-utils.defaulterrormap.delete.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Delete an error.
-
-
-</td></tr>
-<tr><td>
-
-[get(key)](./foundation-utils.defaulterrormap.get.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Get an error by key.
-
-
-</td></tr>
-<tr><td>
-
-[has(key)](./foundation-utils.defaulterrormap.has.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Has an error for key.
-
-
-</td></tr>
-<tr><td>
-
-[set(key, error)](./foundation-utils.defaulterrormap.set.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Set an error by key.
-
-
-</td></tr>
-<tr><td>
-
-[values()](./foundation-utils.defaulterrormap.values.md)
-
-
-</td><td>
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-utils.defaulterrormap.messages.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [messages](./foundation-utils.defaulterrormap.messages.md)
-
-## DefaultErrorMap.messages property
-
-Error map as messages.
-
-**Signature:**
-
-```typescript
-get messages(): string;
-```

package/docs/api/foundation-utils.defaulterrormap.set.md

@@ -1,70 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [set](./foundation-utils.defaulterrormap.set.md)
-
-## DefaultErrorMap.set() method
-
-Set an error by key.
-
-**Signature:**
-
-```typescript
-set(key: keyof TErrorDetailMap, error: Error): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-keyof TErrorDetailMap
-
-
-</td><td>
-
-The key.
-
-
-</td></tr>
-<tr><td>
-
-error
-
-
-</td><td>
-
-Error
-
-
-</td><td>
-
-The error.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-utils.defaulterrormap.size.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [size](./foundation-utils.defaulterrormap.size.md)
-
-## DefaultErrorMap.size property
-
-The size of the error map.
-
-**Signature:**
-
-```typescript
-get size(): number;
-```

package/docs/api/foundation-utils.defaulterrormap.values.md

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultErrorMap](./foundation-utils.defaulterrormap.md) &gt; [values](./foundation-utils.defaulterrormap.values.md)
-
-## DefaultErrorMap.values() method
-
-
-**Signature:**
-
-```typescript
-values(): MapIterator<Error>;
-```
-**Returns:**
-
-MapIterator&lt;Error&gt;
-

package/docs/api/foundation-utils.defaulteventmap.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [defaultEventMap](./foundation-utils.defaulteventmap.md)
-
-## defaultEventMap variable
-
-A map that associates specific HTML element tags with their corresponding default event names.
-
-**Signature:**
-
-```typescript
-defaultEventMap: Map<string, EventName>
-```

package/docs/api/foundation-utils.defaultjsonserializerconfig.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [defaultJSONSerializerConfig](./foundation-utils.defaultjsonserializerconfig.md)
-
-## defaultJSONSerializerConfig variable
-
-A Default JSONSerializer Config for serializing and deserializing functions.
-
-**Signature:**
-
-```typescript
-defaultJSONSerializerConfig: JSONSerializerConfig
-```

package/docs/api/foundation-utils.defaultloggeroptions.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [defaultLoggerOptions](./foundation-utils.defaultloggeroptions.md)
-
-## defaultLoggerOptions variable
-
-The default logger options.
-
-**Signature:**
-
-```typescript
-defaultLoggerOptions: LoggerOptions
-```

package/docs/api/foundation-utils.defaultserverrowdtomapper.fromdto.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [DefaultServerRowDTOMapper](./foundation-utils.defaultserverrowdtomapper.md) &gt; [fromDTO](./foundation-utils.defaultserverrowdtomapper.fromdto.md)
-
-## DefaultServerRowDTOMapper.fromDTO property
-
-Converts a server row DTO to an entity.
-
-**Signature:**
-
-```typescript
-fromDTO: (dto: ServerRowDTO) => ServerRowEntity;
-```