npm - @genesislcap/foundation-workspace - Versions diffs - 14.406.0-workspaces.7 → 14.411.0 - Mend

@genesislcap/foundation-workspace 14.406.0-workspaces.7 → 14.411.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 (149) hide show

package/docs/api/foundation-workspace.defaultfilterregistry.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-workspace](./foundation-workspace.md) &gt; [DefaultFilterRegistry](./foundation-workspace.defaultfilterregistry.md)
-## DefaultFilterRegistry class
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-export declare class DefaultFilterRegistry implements FilterRegistry
-```
-**Implements:** [FilterRegistry](./foundation-workspace.filterregistry.md)

package/docs/api/foundation-workspace.defaultgridregistry.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-workspace](./foundation-workspace.md) &gt; [DefaultGridRegistry](./foundation-workspace.defaultgridregistry.md)
-## DefaultGridRegistry class
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-export declare class DefaultGridRegistry implements GridRegistry
-```
-**Implements:** [GridRegistry](./foundation-workspace.gridregistry.md)

package/docs/api/foundation-workspace.defaultlayoutregistry.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultLayoutRegistry](./foundation-workspace.defaultlayoutregistry.md)
-## DefaultLayoutRegistry class
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Default layout registry implementation.
-**Signature:**
-```typescript
-export declare class DefaultLayoutRegistry implements LayoutRegistry
-```
-**Implements:** [LayoutRegistry](./foundation-workspace.layoutregistry.md)

package/docs/api/foundation-workspace.defaultworkspacestate._constructor_.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-workspace](./foundation-workspace.md) &gt; [DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md) &gt; [(constructor)](./foundation-workspace.defaultworkspacestate._constructor_.md)
-## DefaultWorkspaceState.(constructor)
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Constructs a new instance of the `DefaultWorkspaceState` class
-**Signature:**
-```typescript
-constructor(kvStorage: KVStorageType, auth: AuthType);
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-kvStorage
-</td><td>
-KVStorageType
-</td><td>
-</td></tr>
-<tr><td>
-auth
-</td><td>
-AuthType
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-workspace.defaultworkspacestate.auth.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md) &gt; [auth](./foundation-workspace.defaultworkspacestate.auth.md)
-## DefaultWorkspaceState.auth property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-auth: AuthType;
-```

package/docs/api/foundation-workspace.defaultworkspacestate.kvstorage.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md) &gt; [kvStorage](./foundation-workspace.defaultworkspacestate.kvstorage.md)
-## DefaultWorkspaceState.kvStorage property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-kvStorage: KVStorageType;
-```

package/docs/api/foundation-workspace.defaultworkspacestate.md DELETED Viewed

@@ -1,115 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [DefaultWorkspaceState](./foundation-workspace.defaultworkspacestate.md)
-## DefaultWorkspaceState class
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-Default workspace persistence implementation backed by KVStorage.
-**Signature:**
-```typescript
-export declare class DefaultWorkspaceState implements WorkspaceState
-```
-**Implements:** [WorkspaceState](./foundation-workspace.workspacestate.md)
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(kvStorage, auth)](./foundation-workspace.defaultworkspacestate._constructor_.md)
-</td><td>
-</td><td>
-**_(ALPHA)_** Constructs a new instance of the `DefaultWorkspaceState` class
-</td></tr>
-</tbody></table>
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[auth](./foundation-workspace.defaultworkspacestate.auth.md)
-</td><td>
-</td><td>
-AuthType
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-<tr><td>
-[kvStorage](./foundation-workspace.defaultworkspacestate.kvstorage.md)
-</td><td>
-</td><td>
-KVStorageType
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-</tbody></table>

package/docs/api/foundation-workspace.filterregistration.filterkey.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistration](./foundation-workspace.filterregistration.md) &gt; [filterKey](./foundation-workspace.filterregistration.filterkey.md)
-## FilterRegistration.filterKey property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-filterKey: string;
-```

package/docs/api/foundation-workspace.filterregistration.getfiltervalue.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistration](./foundation-workspace.filterregistration.md) &gt; [getFilterValue](./foundation-workspace.filterregistration.getfiltervalue.md)
-## FilterRegistration.getFilterValue property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-getFilterValue: () => SavedFilterValue | null;
-```

package/docs/api/foundation-workspace.filterregistration.md DELETED Viewed

@@ -1,98 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistration](./foundation-workspace.filterregistration.md)
-## FilterRegistration interface
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-export interface FilterRegistration
-```
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[filterKey](./foundation-workspace.filterregistration.filterkey.md)
-</td><td>
-</td><td>
-string
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-<tr><td>
-[getFilterValue](./foundation-workspace.filterregistration.getfiltervalue.md)
-</td><td>
-</td><td>
-() =&gt; [SavedFilterValue](./foundation-workspace.savedfiltervalue.md) \| null
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-<tr><td>
-[setFilterValue](./foundation-workspace.filterregistration.setfiltervalue.md)
-</td><td>
-</td><td>
-(value: string) =&gt; void
-</td><td>
-**_(ALPHA)_**
-</td></tr>
-</tbody></table>

package/docs/api/foundation-workspace.filterregistration.setfiltervalue.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistration](./foundation-workspace.filterregistration.md) &gt; [setFilterValue](./foundation-workspace.filterregistration.setfiltervalue.md)
-## FilterRegistration.setFilterValue property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-setFilterValue: (value: string) => void;
-```

package/docs/api/foundation-workspace.filterregistry.applyfiltersvalues.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md) &gt; [applyFiltersValues](./foundation-workspace.filterregistry.applyfiltersvalues.md)
-## FilterRegistry.applyFiltersValues() method
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-applyFiltersValues(savedFilters: SavedFilterValue[]): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-savedFilters
-</td><td>
-[SavedFilterValue](./foundation-workspace.savedfiltervalue.md)<!-- -->\[\]
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-workspace.filterregistry.getallfiltersvalues.md DELETED Viewed

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md) &gt; [getAllFiltersValues](./foundation-workspace.filterregistry.getallfiltersvalues.md)
-## FilterRegistry.getAllFiltersValues() method
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-getAllFiltersValues(): SavedFilterValue[];
-```
-**Returns:**
-[SavedFilterValue](./foundation-workspace.savedfiltervalue.md)<!-- -->\[\]

package/docs/api/foundation-workspace.filterregistry.md DELETED Viewed

@@ -1,16 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md)
-## FilterRegistry variable
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-DI token for filter registry.
-**Signature:**
-```typescript
-FilterRegistry: import("@microsoft/fast-foundation").InterfaceSymbol<FilterRegistry>
-```

package/docs/api/foundation-workspace.filterregistry.registerfilter.md DELETED Viewed

@@ -1,81 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md) &gt; [registerFilter](./foundation-workspace.filterregistry.registerfilter.md)
-## FilterRegistry.registerFilter() method
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-registerFilter(filterKey: string, getFilterValue: () => SavedFilterValue | null, setFilterValue: (value: string) => void): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-filterKey
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-getFilterValue
-</td><td>
-() =&gt; [SavedFilterValue](./foundation-workspace.savedfiltervalue.md) \| null
-</td><td>
-</td></tr>
-<tr><td>
-setFilterValue
-</td><td>
-(value: string) =&gt; void
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-workspace.filterregistry.unregisterfilter.md DELETED Viewed

@@ -1,53 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [FilterRegistry](./foundation-workspace.filterregistry.md) &gt; [unregisterFilter](./foundation-workspace.filterregistry.unregisterfilter.md)
-## FilterRegistry.unregisterFilter() method
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-unregisterFilter(filterKey: string): void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-filterKey
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-void

package/docs/api/foundation-workspace.gridregister.gridkey.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegister](./foundation-workspace.gridregister.md) &gt; [gridKey](./foundation-workspace.gridregister.gridkey.md)
-## GridRegister.gridKey property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-gridKey: string;
-```

package/docs/api/foundation-workspace.gridregister.gridregistry.md DELETED Viewed

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-workspace](./foundation-workspace.md) &gt; [GridRegister](./foundation-workspace.gridregister.md) &gt; [gridRegistry](./foundation-workspace.gridregister.gridregistry.md)
-## GridRegister.gridRegistry property
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
->
-**Signature:**
-```typescript
-gridRegistry: GridRegistry;
-```