npm - @genesislcap/foundation-utils - Versions diffs - 14.302.1-alpha-945e484.0 → 14.302.1-alpha-ecc0cfb.0 - Mend

@genesislcap/foundation-utils 14.302.1-alpha-945e484.0 → 14.302.1-alpha-ecc0cfb.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (133) hide show

package/docs/api/foundation-utils.assuredesignsystem.md CHANGED Viewed

@@ -14,37 +14,9 @@ export declare function assureDesignSystem(module: DesignSystemModule): DesignSy
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-module
-</td><td>
-[DesignSystemModule](./foundation-utils.designsystemmodule.md)
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  module | [DesignSystemModule](./foundation-utils.designsystemmodule.md) |  |
 **Returns:**

package/docs/api/foundation-utils.createerrormap.md CHANGED Viewed

@@ -2,7 +2,7 @@
 [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [createErrorMap](./foundation-utils.createerrormap.md)
-## createErrorMap() function
+## createErrorMap variable
 A factory to create the error map.
@@ -11,46 +11,3 @@ A factory to create the error map.
 ```typescript
 createErrorMap: <TErrorDetailMap extends ErrorDetailMap>(logger: ErrorMapLogger) => ErrorMap<TErrorDetailMap>
 ```
-## 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>
-**Returns:**
-[ErrorMap](./foundation-utils.errormap.md)<!-- -->&lt;TErrorDetailMap&gt;
-A ErrorMap instance.

package/docs/api/foundation-utils.createlogger.md CHANGED Viewed

@@ -19,55 +19,10 @@ export declare function createLogger(name: string, options?: LoggerOptions): Log
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-name
-</td><td>
-string
-</td><td>
-The name to give the logger.
-</td></tr>
-<tr><td>
-options
-</td><td>
-[LoggerOptions](./foundation-utils.loggeroptions.md)
-</td><td>
-_(Optional)_ The options to use when creating the logger.
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string | The name to give the logger. |
+|  options | [LoggerOptions](./foundation-utils.loggeroptions.md) | _(Optional)_ The options to use when creating the logger. |
 **Returns:**

package/docs/api/foundation-utils.createobserver.md CHANGED Viewed

@@ -2,7 +2,7 @@
 [Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [createObserver](./foundation-utils.createobserver.md)
-## createObserver() function
+## createObserver variable
 Creates a new event observer instance.
@@ -11,7 +11,3 @@ Creates a new event observer instance.
 ```typescript
 createObserver: <EventType>() => Observer<EventType>
 ```
-**Returns:**
-[Observer](./foundation-utils.observer.md)<!-- -->&lt;EventType&gt;

package/docs/api/foundation-utils.customnumberparser.md CHANGED Viewed

@@ -14,37 +14,9 @@ export declare function customNumberParser(value: any): number | bigint;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-value
-</td><td>
-any
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  value | any |  |
 **Returns:**

package/docs/api/foundation-utils.database.create.md CHANGED Viewed

@@ -12,37 +12,9 @@ create(newValue: Omit<T, 'id'>): Promise<DatabaseAccessResult.Create<T>>;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-newValue
-</td><td>
-Omit&lt;T, 'id'&gt;
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  newValue | Omit&lt;T, 'id'&gt; |  |
 **Returns:**

package/docs/api/foundation-utils.database.delete.md CHANGED Viewed

@@ -12,37 +12,9 @@ delete(id: string): Promise<DatabaseAccessResult.Delete>;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-id
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  id | string |  |
 **Returns:**

package/docs/api/foundation-utils.database.md CHANGED Viewed

@@ -14,121 +14,19 @@ export interface Database<T extends DatabaseRecord>
 ## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[isWorking](./foundation-utils.database.isworking.md)
-</td><td>
-</td><td>
-boolean
-</td><td>
-</td></tr>
-</tbody></table>
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isWorking](./foundation-utils.database.isworking.md) |  | boolean |  |
 ## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[create(newValue)](./foundation-utils.database.create.md)
-</td><td>
-</td></tr>
-<tr><td>
-[delete(id)](./foundation-utils.database.delete.md)
-</td><td>
-</td></tr>
-<tr><td>
-[onAfterUpdate(listener)](./foundation-utils.database.onafterupdate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[onBeforeUpdate(listener)](./foundation-utils.database.onbeforeupdate.md)
-</td><td>
-</td></tr>
-<tr><td>
-[read(id)](./foundation-utils.database.read.md)
-</td><td>
-</td></tr>
-<tr><td>
-[update(id, newValue)](./foundation-utils.database.update.md)
-</td><td>
-</td></tr>
-<tr><td>
-[visit(visitor)](./foundation-utils.database.visit.md)
-</td><td>
-</td></tr>
-</tbody></table>
+|  Method | Description |
+|  --- | --- |
+|  [create(newValue)](./foundation-utils.database.create.md) |  |
+|  [delete(id)](./foundation-utils.database.delete.md) |  |
+|  [onAfterUpdate(listener)](./foundation-utils.database.onafterupdate.md) |  |
+|  [onBeforeUpdate(listener)](./foundation-utils.database.onbeforeupdate.md) |  |
+|  [read(id)](./foundation-utils.database.read.md) |  |
+|  [update(id, newValue)](./foundation-utils.database.update.md) |  |
+|  [visit(visitor)](./foundation-utils.database.visit.md) |  |

package/docs/api/foundation-utils.database.onafterupdate.md CHANGED Viewed

@@ -12,37 +12,9 @@ onAfterUpdate(listener: Listener<DatabaseEvent.AfterUpdate<T>>): () => void;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-listener
-</td><td>
-[Listener](./foundation-utils.listener.md)<!-- -->&lt;[DatabaseEvent.AfterUpdate](./foundation-utils.databaseevent.afterupdate.md)<!-- -->&lt;T&gt;&gt;
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | [Listener](./foundation-utils.listener.md)<!-- -->&lt;[DatabaseEvent.AfterUpdate](./foundation-utils.databaseevent.afterupdate.md)<!-- -->&lt;T&gt;&gt; |  |
 **Returns:**

package/docs/api/foundation-utils.database.onbeforeupdate.md CHANGED Viewed

@@ -12,37 +12,9 @@ onBeforeUpdate(listener: Listener<DatabaseEvent.BeforeUpdate<T>>): () => void;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-listener
-</td><td>
-[Listener](./foundation-utils.listener.md)<!-- -->&lt;[DatabaseEvent.BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md)<!-- -->&lt;T&gt;&gt;
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  listener | [Listener](./foundation-utils.listener.md)<!-- -->&lt;[DatabaseEvent.BeforeUpdate](./foundation-utils.databaseevent.beforeupdate.md)<!-- -->&lt;T&gt;&gt; |  |
 **Returns:**

package/docs/api/foundation-utils.database.read.md CHANGED Viewed

@@ -12,37 +12,9 @@ read(id: string): Promise<DatabaseAccessResult.Read<T>>;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-id
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  id | string |  |
 **Returns:**

package/docs/api/foundation-utils.database.update.md CHANGED Viewed

@@ -12,51 +12,10 @@ update(id: string, newValue: Omit<Partial<T>, 'id'>): Promise<DatabaseAccessResu
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-id
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-newValue
-</td><td>
-Omit&lt;Partial&lt;T&gt;, 'id'&gt;
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  id | string |  |
+|  newValue | Omit&lt;Partial&lt;T&gt;, 'id'&gt; |  |
 **Returns:**

package/docs/api/foundation-utils.database.visit.md CHANGED Viewed

@@ -12,37 +12,9 @@ visit(visitor: (record: T) => void): Promise<void>;
 ## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-visitor
-</td><td>
-(record: T) =&gt; void
-</td><td>
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  visitor | (record: T) =&gt; void |  |
 **Returns:**

package/docs/api/foundation-utils.databaseaccessresult.access.md CHANGED Viewed

@@ -12,43 +12,7 @@ interface Access<T>
 ## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[value](./foundation-utils.databaseaccessresult.access.value.md)
-</td><td>
-</td><td>
-T
-</td><td>
-</td></tr>
-</tbody></table>
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [value](./foundation-utils.databaseaccessresult.access.value.md) |  | T |  |