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.delay.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; [delay](./foundation-utils.delay.md)
-## delay() function
-Delay for a given number of milliseconds
-**Signature:**
-```typescript
-delay: (ms: number) => Promise<void>
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-ms
-</td><td>
-number
-</td><td>
-The number of milliseconds to delay
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;void&gt;
-A promise that resolves after the given number of milliseconds
-## Example
-```ts
-await delay(1000);
-console.log('1 second later');
-```

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

@@ -1,38 +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; [DesignSystemModule](./foundation-utils.designsystemmodule.md)
-## DesignSystemModule interface
-DesignSystemModule.
-**Signature:**
-```typescript
-export interface DesignSystemModule
-```
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[provideDesignSystem(element, prefix)](./foundation-utils.designsystemmodule.providedesignsystem.md)
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.designsystemmodule.providedesignsystem.md DELETED Viewed

@@ -1,68 +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; [DesignSystemModule](./foundation-utils.designsystemmodule.md) &gt; [provideDesignSystem](./foundation-utils.designsystemmodule.providedesignsystem.md)
-## DesignSystemModule.provideDesignSystem() method
-**Signature:**
-```typescript
-provideDesignSystem(element?: HTMLElement, prefix?: string): DesignSystem | Pick<DesignSystem, 'register'>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-element
-</td><td>
-HTMLElement
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-prefix
-</td><td>
-string
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>
-**Returns:**
-DesignSystem \| Pick&lt;DesignSystem, 'register'&gt;

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

@@ -1,15 +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; [DesignSystemResource](./foundation-utils.designsystemresource.md)
-## DesignSystemResource type
-DesignSystemResource.
-**Signature:**
-```typescript
-export type DesignSystemResource<T = DesignSystemModule> = Promise<T>;
-```
-**References:** [DesignSystemModule](./foundation-utils.designsystemmodule.md)

package/docs/api/foundation-utils.dtomapper.fromargs.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; [DTOMapper](./foundation-utils.dtomapper.md) &gt; [fromArgs](./foundation-utils.dtomapper.fromargs.md)
-## DTOMapper.fromArgs property
-**Signature:**
-```typescript
-fromArgs?: (...args: any[]) => TEntity;
-```

package/docs/api/foundation-utils.dtomapper.fromdto.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; [DTOMapper](./foundation-utils.dtomapper.md) &gt; [fromDTO](./foundation-utils.dtomapper.fromdto.md)
-## DTOMapper.fromDTO property
-**Signature:**
-```typescript
-fromDTO: (dto: TDTO) => TEntity;
-```

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

@@ -1,91 +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; [DTOMapper](./foundation-utils.dtomapper.md)
-## DTOMapper interface
-**Signature:**
-```typescript
-export interface DTOMapper<TDTO, TEntity>
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[fromArgs?](./foundation-utils.dtomapper.fromargs.md)
-</td><td>
-</td><td>
-(...args: any\[\]) =&gt; TEntity
-</td><td>
-_(Optional)_
-</td></tr>
-<tr><td>
-[fromDTO](./foundation-utils.dtomapper.fromdto.md)
-</td><td>
-</td><td>
-(dto: TDTO) =&gt; TEntity
-</td><td>
-</td></tr>
-<tr><td>
-[toDTO](./foundation-utils.dtomapper.todto.md)
-</td><td>
-</td><td>
-(entity: Partial&lt;TEntity&gt;) =&gt; TDTO
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.dtomapper.todto.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; [DTOMapper](./foundation-utils.dtomapper.md) &gt; [toDTO](./foundation-utils.dtomapper.todto.md)
-## DTOMapper.toDTO property
-**Signature:**
-```typescript
-toDTO: (entity: Partial<TEntity>) => TDTO;
-```

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

@@ -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; [encodeToBase64](./foundation-utils.encodetobase64.md)
-## encodeToBase64() function
-Encodes the given value to base64.
-**Signature:**
-```typescript
-encodeToBase64: (value: string | ArrayBuffer) => string
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-value
-</td><td>
-string \| ArrayBuffer
-</td><td>
-The value to encode to base64.
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-The base64 encoded value.

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

@@ -1,60 +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; [encodeToBase64WithPrefix](./foundation-utils.encodetobase64withprefix.md)
-## encodeToBase64WithPrefix() function
-Encodes the given value with a prefix to base64.
-**Signature:**
-```typescript
-encodeToBase64WithPrefix: (value: string | ArrayBuffer) => string
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-value
-</td><td>
-string \| ArrayBuffer
-</td><td>
-The value to encode to base64.
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-The base64 encoded value with a prefix.
-## Remarks
-Prefixes are: 'str:' for string and 'bin:' for ArrayBuffer.

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

@@ -1,12 +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; [ENVIRONMENT\_LEVEL](./foundation-utils.environment_level.md)
-## ENVIRONMENT\_LEVEL variable
-**Signature:**
-```typescript
-ENVIRONMENT_LEVEL: string
-```

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

@@ -1,12 +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; [ErrorDetailMap](./foundation-utils.errordetailmap.md)
-## ErrorDetailMap type
-**Signature:**
-```typescript
-export type ErrorDetailMap = Record<string, unknown>;
-```

package/docs/api/foundation-utils.errormap.lasterror.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; [ErrorMap](./foundation-utils.errormap.md) &gt; [lastError](./foundation-utils.errormap.lasterror.md)
-## ErrorMap.lastError property
-The last set error if any.
-**Signature:**
-```typescript
-readonly lastError: Error;
-```

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

@@ -1,107 +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; [ErrorMap](./foundation-utils.errormap.md)
-## ErrorMap interface
-**Signature:**
-```typescript
-export interface ErrorMap<TErrorDetailMap extends ErrorDetailMap> extends Pick<Map<keyof TErrorDetailMap, Error>, 'get' | 'has' | 'delete' | 'clear' | 'size' | 'values'>
-```
-**Extends:** Pick&lt;Map&lt;keyof TErrorDetailMap, Error&gt;, 'get' \| 'has' \| 'delete' \| 'clear' \| 'size' \| 'values'&gt;
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[lastError](./foundation-utils.errormap.lasterror.md)
-</td><td>
-`readonly`
-</td><td>
-Error
-</td><td>
-The last set error if any.
-</td></tr>
-<tr><td>
-[messages](./foundation-utils.errormap.messages.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-Error map as messages.
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[set(key, error)](./foundation-utils.errormap.set.md)
-</td><td>
-Set an error by key.
-</td></tr>
-</tbody></table>

package/docs/api/foundation-utils.errormap.messages.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; [ErrorMap](./foundation-utils.errormap.md) &gt; [messages](./foundation-utils.errormap.messages.md)
-## ErrorMap.messages property
-Error map as messages.
-**Signature:**
-```typescript
-readonly messages: string;
-```

package/docs/api/foundation-utils.errormap.set.md DELETED Viewed

@@ -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; [ErrorMap](./foundation-utils.errormap.md) &gt; [set](./foundation-utils.errormap.set.md)
-## ErrorMap.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.errormaplogger.md DELETED Viewed

@@ -1,12 +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; [ErrorMapLogger](./foundation-utils.errormaplogger.md)
-## ErrorMapLogger type
-**Signature:**
-```typescript
-export type ErrorMapLogger = (...args: any[]) => void;
-```

package/docs/api/foundation-utils.eventname.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; [EventName](./foundation-utils.eventname.md)
-## EventName type
-Represents the possible event names for data synchronization.
-**Signature:**
-```typescript
-export type EventName = 'input' | 'change' | 'default';
-```