@genesislcap/foundation-utils 14.408.0 → 14.409.0

package/docs/api/foundation-utils.popup_default_width.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; [POPUP\_DEFAULT\_WIDTH](./foundation-utils.popup_default_width.md)
-
-## POPUP\_DEFAULT\_WIDTH variable
-
-The default width (in pixels) for pop-up windows.
-
-**Signature:**
-
-```typescript
-POPUP_DEFAULT_WIDTH = 483
-```

package/docs/api/foundation-utils.public_path.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; [PUBLIC\_PATH](./foundation-utils.public_path.md)
-
-## PUBLIC\_PATH variable
-
-The public path.
-
-**Signature:**
-
-```typescript
-_PUBLIC_PATH: string
-```
-
-## Example
-
-'/', '/app/'.
-

package/docs/api/foundation-utils.publish.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; [Publish](./foundation-utils.publish.md)
-
-## Publish type
-
-Publishes an event of a specific type to all subscribed listeners.
-
-**Signature:**
-
-```typescript
-export type Publish<EventType> = (event: EventType) => void;
-```

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

@@ -1,104 +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; [reactive](./foundation-utils.reactive.md)
-
-## reactive() function
-
-> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Converts a plain object to a reactive, observable object.
-
-**Signature:**
-
-```typescript
-export declare function reactive<T>(object: T, deep?: boolean): T;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-object
-
-
-</td><td>
-
-T
-
-
-</td><td>
-
-The object to make reactive.
-
-
-</td></tr>
-<tr><td>
-
-deep
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ Indicates whether to deeply convert the object.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-T
-
-The converted object.
-
-## Example 1
-
-An array or reactive items.
-
-```ts
-this.todos = todosResponse.map((t) => reactive(t));
-```
-
-## Example 2
-
-Add item.
-
-```ts
-add(description: string) {
-   this.splice(this.todos.length, 0, reactive({ description, done: false }));
-}
-```
-
-## Example 3
-
-Remove item.
-
-```ts
-remove(todo: Todo) {
-   const index = this.todos.indexOf(todo);
-   index !== -1 && this.splice(index, 1);
-}
-```
-

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

@@ -1,96 +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; [renderOnChange](./foundation-utils.renderonchange.md)
-
-## renderOnChange() function
-
-Defines a property changed handler that calls a render() method on the target as an internal observation enhancement.
-
-**Signature:**
-
-```typescript
-export declare function renderOnChange(target: FASTElement & {
-    render(): void;
-}, name: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-target
-
-
-</td><td>
-
-FASTElement &amp; { render(): void; }
-
-
-</td><td>
-
-The target to define the property change handler on.
-
-
-</td></tr>
-<tr><td>
-
-name
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The property name.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-
-## Remarks
-
-This is useful if you have a lot of properties that all invalidate the internal state. See [https://www.fast.design/docs/fast-element/observables-and-state\#internal-observation](https://www.fast.design/docs/fast-element/observables-and-state#internal-observation) for more information.
-
-## Example
-
-
-```ts
- @attr({ mode: 'boolean', attribute: 'line-numbers' })
- @renderOnChange
- lineNumbers: boolean = true;
-
- @attr
- @renderOnChange
- indent: number | 'tab' = 2;
-
- render() {
-   if (!this.$fastController.isConnected) {
-     return;
-   }
-   // Do something...
- }
-```
-

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

@@ -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; [RESET\_PASSWORD\_URL](./foundation-utils.reset_password_url.md)
-
-## RESET\_PASSWORD\_URL variable
-
-
-**Signature:**
-
-```typescript
-RESET_PASSWORD_URL: string
-```

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

@@ -1,79 +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; [resolveAfter](./foundation-utils.resolveafter.md)
-
-## resolveAfter() function
-
-Resolve a promise after a timeout.
-
-**Signature:**
-
-```typescript
-resolveAfter: <T = any>(ms: number, valueCreator: () => T) => Promise<T>
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-ms
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-valueCreator
-
-
-</td><td>
-
-() =&gt; T
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;T&gt;
-
-## Example
-
-
-```ts
-const result = await Promise.race([
- resourceChecks(sourceRef, resource),
- resolveAfter<MonitoredResourceChecksResult>(this.config.checkTimeout, () => ({
-   isConnected: false,
-   lastUpdated: Date.now(),
-  })),
-]);
-```
-

package/docs/api/foundation-utils.resourcetype.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; [ResourceType](./foundation-utils.resourcetype.md)
-
-## ResourceType variable
-
-An object that defines two resource types: "local" and "remote".
-
-**Signature:**
-
-```typescript
-ResourceType: {
-    readonly local: "local";
-    readonly remote: "remote";
-}
-```

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

@@ -1,72 +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; [respondToVisibility](./foundation-utils.respondtovisibility.md)
-
-## respondToVisibility() function
-
-Setup an `IntersectionObserver` which will activate a callback function when an element becomes visible on screen
-
-**Signature:**
-
-```typescript
-respondToVisibility: (element: HTMLElement, callback: (arg0: boolean) => any) => (() => void)
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-element
-
-
-</td><td>
-
-HTMLElement
-
-
-</td><td>
-
-HTMLElement to observe
-
-
-</td></tr>
-<tr><td>
-
-callback
-
-
-</td><td>
-
-(arg0: boolean) =&gt; any
-
-
-</td><td>
-
-any function called when the visibility changes
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-(() =&gt; void)
-
-A cleanup function to disconnect the observer
-

package/docs/api/foundation-utils.routeutil.destroy.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; [RouteUtil](./foundation-utils.routeutil.md) &gt; [destroy](./foundation-utils.routeutil.destroy.md)
-
-## RouteUtil.destroy() method
-
-Clean up route detection listeners and polling.
-
-**Signature:**
-
-```typescript
-destroy(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,115 +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; [RouteUtil](./foundation-utils.routeutil.md)
-
-## RouteUtil class
-
-A singleton utility to observe and notify about route changes. It uses both polling and popstate events to detect changes.
-
-**Signature:**
-
-```typescript
-export declare class RouteUtil 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[pathName](./foundation-utils.routeutil.pathname.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The current pathname of the window location.
-
-
-</td></tr>
-<tr><td>
-
-[shared](./foundation-utils.routeutil.shared.md)
-
-
-</td><td>
-
-`static`
-
-`readonly`
-
-
-</td><td>
-
-[RouteUtil](./foundation-utils.routeutil.md)
-
-
-</td><td>
-
-Gets the singleton instance of RouteUtil.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[destroy()](./foundation-utils.routeutil.destroy.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Clean up route detection listeners and polling.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-utils.routeutil.pathname.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; [RouteUtil](./foundation-utils.routeutil.md) &gt; [pathName](./foundation-utils.routeutil.pathname.md)
-
-## RouteUtil.pathName property
-
-The current pathname of the window location.
-
-**Signature:**
-
-```typescript
-pathName: string;
-```

package/docs/api/foundation-utils.routeutil.shared.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; [RouteUtil](./foundation-utils.routeutil.md) &gt; [shared](./foundation-utils.routeutil.shared.md)
-
-## RouteUtil.shared property
-
-Gets the singleton instance of RouteUtil.
-
-**Signature:**
-
-```typescript
-static get shared(): RouteUtil;
-```

package/docs/api/foundation-utils.serverrowdto.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; [ServerRowDTO](./foundation-utils.serverrowdto.md)
-
-## ServerRowDTO type
-
-The data for a server row DTO.
-
-**Signature:**
-
-```typescript
-export type ServerRowDTO = {
-    DETAILS: {
-        OPERATION: UppercaseOperation;
-        ROW_REF: string;
-    };
-};
-```

package/docs/api/foundation-utils.serverrowdtomapper.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; [ServerRowDTOMapper](./foundation-utils.serverrowdtomapper.md)
-
-## ServerRowDTOMapper variable
-
-A DI token used to obtain a `ServerRowDTOMapper` instance.
-
-**Signature:**
-
-```typescript
-ServerRowDTOMapper: import("@microsoft/fast-foundation").InterfaceSymbol<ServerRowDTOMapper>
-```

package/docs/api/foundation-utils.serverrowentity.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; [ServerRowEntity](./foundation-utils.serverrowentity.md)
-
-## ServerRowEntity type
-
-The data for a server row entity.
-
-**Signature:**
-
-```typescript
-export type ServerRowEntity = {
-    serverRowMetadata: {
-        operation: LowercaseOperation;
-        rowRef: string;
-    };
-};
-```

package/docs/api/foundation-utils.shortcutdefinition.action.md

@@ -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; [ShortcutDefinition](./foundation-utils.shortcutdefinition.md) &gt; [action](./foundation-utils.shortcutdefinition.action.md)
-
-## ShortcutDefinition.action property
-
-**Signature:**
-
-```typescript
-action: () => void;
-```

package/docs/api/foundation-utils.shortcutdefinition.altkey.md

@@ -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; [ShortcutDefinition](./foundation-utils.shortcutdefinition.md) &gt; [altKey](./foundation-utils.shortcutdefinition.altkey.md)
-
-## ShortcutDefinition.altKey property
-
-**Signature:**
-
-```typescript
-altKey?: boolean;
-```

package/docs/api/foundation-utils.shortcutdefinition.canexecute.md

@@ -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; [ShortcutDefinition](./foundation-utils.shortcutdefinition.md) &gt; [canExecute](./foundation-utils.shortcutdefinition.canexecute.md)
-
-## ShortcutDefinition.canExecute property
-
-**Signature:**
-
-```typescript
-canExecute?: () => ShortcutExecutionStatus;
-```

package/docs/api/foundation-utils.shortcutdefinition.context.md

@@ -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; [ShortcutDefinition](./foundation-utils.shortcutdefinition.md) &gt; [context](./foundation-utils.shortcutdefinition.context.md)
-
-## ShortcutDefinition.context property
-
-**Signature:**
-
-```typescript
-context: string;
-```