npm - @genesislcap/foundation-utils - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-utils 14.408.0 → 14.409.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 (305) hide show

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

@@ -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; [createObserver](./foundation-utils.createobserver.md)
-## createObserver() function
-Creates a new event observer instance.
-**Signature:**
-```typescript
-createObserver: <EventType>() => Observer<EventType>
-```
-**Returns:**
-[Observer](./foundation-utils.observer.md)<!-- -->&lt;EventType&gt;

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

@@ -1,52 +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; [customNumberParser](./foundation-utils.customnumberparser.md)
-## customNumberParser() function
-A Default Number Parser for deserializing objects.
-**Signature:**
-```typescript
-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>
-**Returns:**
-number \| bigint

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

@@ -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; [Database](./foundation-utils.database.md) &gt; [create](./foundation-utils.database.create.md)
-## Database.create() method
-**Signature:**
-```typescript
-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>
-**Returns:**
-Promise&lt;[DatabaseAccessResult.Create](./foundation-utils.databaseaccessresult.create.md)<!-- -->&lt;T&gt;&gt;

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

@@ -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; [Database](./foundation-utils.database.md) &gt; [delete](./foundation-utils.database.delete.md)
-## Database.delete() method
-**Signature:**
-```typescript
-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>
-**Returns:**
-Promise&lt;[DatabaseAccessResult.Delete](./foundation-utils.databaseaccessresult.delete.md)<!-- -->&gt;

package/docs/api/foundation-utils.database.isworking.md DELETED Viewed

@@ -1,11 +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; [Database](./foundation-utils.database.md) &gt; [isWorking](./foundation-utils.database.isworking.md)
-## Database.isWorking property
-**Signature:**
-```typescript
-isWorking: boolean;
-```

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

@@ -1,134 +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; [Database](./foundation-utils.database.md)
-## Database interface
-Represents a database with basic CRUD operations.
-**Signature:**
-```typescript
-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>
-## 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>

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

@@ -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; [Database](./foundation-utils.database.md) &gt; [onAfterUpdate](./foundation-utils.database.onafterupdate.md)
-## Database.onAfterUpdate() method
-**Signature:**
-```typescript
-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>
-**Returns:**
-() =&gt; void

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

@@ -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; [Database](./foundation-utils.database.md) &gt; [onBeforeUpdate](./foundation-utils.database.onbeforeupdate.md)
-## Database.onBeforeUpdate() method
-**Signature:**
-```typescript
-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>
-**Returns:**
-() =&gt; void

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

@@ -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; [Database](./foundation-utils.database.md) &gt; [read](./foundation-utils.database.read.md)
-## Database.read() method
-**Signature:**
-```typescript
-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>
-**Returns:**
-Promise&lt;[DatabaseAccessResult.Read](./foundation-utils.databaseaccessresult.read.md)<!-- -->&lt;T&gt;&gt;

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

@@ -1,64 +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; [Database](./foundation-utils.database.md) &gt; [update](./foundation-utils.database.update.md)
-## Database.update() method
-**Signature:**
-```typescript
-update(id: string, newValue: Omit<Partial<T>, 'id'>): Promise<DatabaseAccessResult.Update<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>
-<tr><td>
-newValue
-</td><td>
-Omit&lt;Partial&lt;T&gt;, 'id'&gt;
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;[DatabaseAccessResult.Update](./foundation-utils.databaseaccessresult.update.md)<!-- -->&lt;T&gt;&gt;

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

@@ -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; [Database](./foundation-utils.database.md) &gt; [visit](./foundation-utils.database.visit.md)
-## Database.visit() method
-**Signature:**
-```typescript
-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>
-**Returns:**
-Promise&lt;void&gt;

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

@@ -1,54 +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; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Access](./foundation-utils.databaseaccessresult.access.md)
-## DatabaseAccessResult.Access interface
-**Signature:**
-```typescript
-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>

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

@@ -1,11 +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; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Access](./foundation-utils.databaseaccessresult.access.md) &gt; [value](./foundation-utils.databaseaccessresult.access.value.md)
-## DatabaseAccessResult.Access.value property
-**Signature:**
-```typescript
-value: T;
-```

package/docs/api/foundation-utils.databaseaccessresult.create.md DELETED Viewed

@@ -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; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Create](./foundation-utils.databaseaccessresult.create.md)
-## DatabaseAccessResult.Create interface
-**Signature:**
-```typescript
-export interface Create<T> extends Access<T>
-```
-**Extends:** Access&lt;T&gt;

package/docs/api/foundation-utils.databaseaccessresult.delete.id.md DELETED Viewed

@@ -1,11 +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; [DatabaseAccessResult](./foundation-utils.databaseaccessresult.md) &gt; [Delete](./foundation-utils.databaseaccessresult.delete.md) &gt; [id](./foundation-utils.databaseaccessresult.delete.id.md)
-## DatabaseAccessResult.Delete.id property
-**Signature:**
-```typescript
-id: string;
-```