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

@genesislcap/foundation-utils 14.408.0 → 14.409.0-FUI-2495.1

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.insertdocumentcssrule.md DELETED Viewed

@@ -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; [insertDocumentCSSRule](./foundation-utils.insertdocumentcssrule.md)
-## insertDocumentCSSRule() function
-Inserts a CSS rule into the document by creating a new style element or using an existing one with the specified ID. Returns a function that can be called to remove the rule from the document.
-**Signature:**
-```typescript
-insertDocumentCSSRule: (cssRule: string, styleElementId: string) => (() => void)
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-cssRule
-</td><td>
-string
-</td><td>
-The CSS rule to insert.
-</td></tr>
-<tr><td>
-styleElementId
-</td><td>
-string
-</td><td>
-The ID of the style element to use or create.
-</td></tr>
-</tbody></table>
-**Returns:**
-(() =&gt; void)
-A function that removes the rule from the document.

package/docs/api/foundation-utils.insertdocumentlink.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; [insertDocumentLink](./foundation-utils.insertdocumentlink.md)
-## insertDocumentLink() function
-Inserts a CSS link into the document if it doesn't already exist.
-**Signature:**
-```typescript
-insertDocumentLink: (href: string) => void
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-href
-</td><td>
-string
-</td><td>
-The URL of the CSS file to insert.
-</td></tr>
-</tbody></table>
-**Returns:**
-void

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

@@ -1,19 +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; [inSymphonyDesktop](./foundation-utils.insymphonydesktop.md)
-## inSymphonyDesktop() function
-Returns a boolean value indicating whether the user is running the Symphony desktop app.
-**Signature:**
-```typescript
-inSymphonyDesktop: () => boolean
-```
-**Returns:**
-boolean
-true if the user is running the Symphony desktop app, false otherwise.

package/docs/api/foundation-utils.isdev.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; [isDev](./foundation-utils.isdev.md)
-## isDev() function
-Determines if the current environment is a development environment.
-**Signature:**
-```typescript
-isDev: () => boolean
-```
-**Returns:**
-boolean

package/docs/api/foundation-utils.isfeatureactivated.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; [isFeatureActivated](./foundation-utils.isfeatureactivated.md)
-## isFeatureActivated() function
-**Signature:**
-```typescript
-isFeatureActivated: (feature: string) => boolean
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-feature
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean

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

@@ -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; [JSONReplacer](./foundation-utils.jsonreplacer.md)
-## JSONReplacer() function
-JSON replacer function.
-**Signature:**
-```typescript
-export declare function JSONReplacer(key: string, value: any): any;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-key
-</td><td>
-string
-</td><td>
-The object key.
-</td></tr>
-<tr><td>
-value
-</td><td>
-any
-</td><td>
-The key value.
-</td></tr>
-</tbody></table>
-**Returns:**
-any
-The resulting value.

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

@@ -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; [JSONReviver](./foundation-utils.jsonreviver.md)
-## JSONReviver() function
-JSON reviver function.
-**Signature:**
-```typescript
-export declare function JSONReviver(key: string, value: any): any;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-key
-</td><td>
-string
-</td><td>
-The object key.
-</td></tr>
-<tr><td>
-value
-</td><td>
-any
-</td><td>
-The key value.
-</td></tr>
-</tbody></table>
-**Returns:**
-any
-The resulting value.

package/docs/api/foundation-utils.jsonserializer.deserialize.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; [JSONSerializer](./foundation-utils.jsonserializer.md) &gt; [deserialize](./foundation-utils.jsonserializer.deserialize.md)
-## JSONSerializer.deserialize() method
-Deserializes a response object from a HTTP request to a JavaScript object.
-**Signature:**
-```typescript
-deserialize<T = any>(response: Response): Promise<T>;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-response
-</td><td>
-Response
-</td><td>
-The HTTP response object.
-</td></tr>
-</tbody></table>
-**Returns:**
-Promise&lt;T&gt;
-A promise that resolves to the deserialized JavaScript object.

package/docs/api/foundation-utils.jsonserializer.deserialize_1.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; [JSONSerializer](./foundation-utils.jsonserializer.md) &gt; [deserialize](./foundation-utils.jsonserializer.deserialize_1.md)
-## JSONSerializer.deserialize() method
-Deserializes a message event object to a JavaScript object.
-**Signature:**
-```typescript
-deserialize<T = any>(event: MessageEvent): T;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-event
-</td><td>
-MessageEvent
-</td><td>
-The message event object.
-</td></tr>
-</tbody></table>
-**Returns:**
-T
-The deserialized JavaScript object.

package/docs/api/foundation-utils.jsonserializer.deserialize_2.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; [JSONSerializer](./foundation-utils.jsonserializer.md) &gt; [deserialize](./foundation-utils.jsonserializer.deserialize_2.md)
-## JSONSerializer.deserialize() method
-Deserializes a JSON string to a JavaScript object.
-**Signature:**
-```typescript
-deserialize<T = any>(text: string): T;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-text
-</td><td>
-string
-</td><td>
-The JSON string to deserialize.
-</td></tr>
-</tbody></table>
-**Returns:**
-T
-The deserialized JavaScript object.

package/docs/api/foundation-utils.jsonserializer.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; [JSONSerializer](./foundation-utils.jsonserializer.md)
-## JSONSerializer variable
-A DI token for the JSON serializer.
-**Signature:**
-```typescript
-JSONSerializer: import("@microsoft/fast-foundation").InterfaceSymbol<JSONSerializer>
-```

package/docs/api/foundation-utils.jsonserializer.serialize.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; [JSONSerializer](./foundation-utils.jsonserializer.md) &gt; [serialize](./foundation-utils.jsonserializer.serialize.md)
-## JSONSerializer.serialize() method
-Serializes an object to a JSON string.
-**Signature:**
-```typescript
-serialize(object: any): string;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-object
-</td><td>
-any
-</td><td>
-The object to serialize.
-</td></tr>
-</tbody></table>
-**Returns:**
-string
-The serialized JSON string.

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

@@ -1,65 +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; [JSONSerializerConfig](./foundation-utils.jsonserializerconfig.md)
-## JSONSerializerConfig interface
-Configuration options for the JSONSerializer Config instance.
-**Signature:**
-```typescript
-export interface JSONSerializerConfig
-```
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[parse(text, reviver)](./foundation-utils.jsonserializerconfig.parse.md)
-</td><td>
-</td></tr>
-<tr><td>
-[parse(text, reviver, parseNumber)](./foundation-utils.jsonserializerconfig.parse_1.md)
-</td><td>
-</td></tr>
-<tr><td>
-[stringify(value, replacer, space)](./foundation-utils.jsonserializerconfig.stringify.md)
-</td><td>
-</td></tr>
-<tr><td>
-[stringify(value, replacer, space)](./foundation-utils.jsonserializerconfig.stringify_1.md)
-</td><td>
-</td></tr>
-</tbody></table>