@genesislcap/foundation-comms 14.187.1 → 14.188.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.
- package/dist/dts/connect/connect.d.ts +11 -6
- package/dist/dts/connect/connect.d.ts.map +1 -1
- package/dist/dts/connect/http.connect.d.ts +2 -2
- package/dist/dts/connect/http.connect.d.ts.map +1 -1
- package/dist/dts/connect/message.d.ts +11 -0
- package/dist/dts/connect/message.d.ts.map +1 -1
- package/dist/dts/connect/socket.d.ts +6 -2
- package/dist/dts/connect/socket.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.config.d.ts +44 -0
- package/dist/dts/datasource/datasource.config.d.ts.map +1 -0
- package/dist/dts/datasource/datasource.d.ts +49 -19
- package/dist/dts/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/datasource/datasource.mixins.d.ts +367 -0
- package/dist/dts/datasource/datasource.mixins.d.ts.map +1 -0
- package/dist/dts/datasource/datasource.types.d.ts +14 -22
- package/dist/dts/datasource/datasource.types.d.ts.map +1 -1
- package/dist/dts/datasource/entityDatasource.d.ts +5 -8
- package/dist/dts/datasource/entityDatasource.d.ts.map +1 -1
- package/dist/dts/datasource/index.d.ts +2 -0
- package/dist/dts/datasource/index.d.ts.map +1 -1
- package/dist/dts/index.d.ts +1 -0
- package/dist/dts/index.d.ts.map +1 -1
- package/dist/dts/resources/genesis/config.d.ts +81 -0
- package/dist/dts/resources/genesis/config.d.ts.map +1 -0
- package/dist/dts/resources/genesis/genesis.d.ts +69 -0
- package/dist/dts/resources/genesis/genesis.d.ts.map +1 -0
- package/dist/dts/resources/genesis/index.d.ts +4 -0
- package/dist/dts/resources/genesis/index.d.ts.map +1 -0
- package/dist/dts/resources/genesis/types.d.ts +19 -0
- package/dist/dts/resources/genesis/types.d.ts.map +1 -0
- package/dist/dts/resources/index.d.ts +2 -0
- package/dist/dts/resources/index.d.ts.map +1 -0
- package/dist/dts/testing/mocks/auth/auth.d.ts +3 -0
- package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
- package/dist/dts/testing/mocks/connect/connect.d.ts +3 -2
- package/dist/dts/testing/mocks/connect/connect.d.ts.map +1 -1
- package/dist/dts/testing/mocks/connect/socket.d.ts +1 -0
- package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
- package/dist/dts/testing/mocks/datasource/datasource.d.ts +22 -4
- package/dist/dts/testing/mocks/datasource/datasource.d.ts.map +1 -1
- package/dist/dts/testing/mocks/index.d.ts +1 -0
- package/dist/dts/testing/mocks/index.d.ts.map +1 -1
- package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts +16 -0
- package/dist/dts/testing/mocks/resources/genesis/genesis.d.ts.map +1 -0
- package/dist/dts/testing/mocks/resources/genesis/index.d.ts +2 -0
- package/dist/dts/testing/mocks/resources/genesis/index.d.ts.map +1 -0
- package/dist/dts/testing/mocks/resources/index.d.ts +2 -0
- package/dist/dts/testing/mocks/resources/index.d.ts.map +1 -0
- package/dist/esm/connect/connect.js +12 -15
- package/dist/esm/connect/http.connect.js +5 -3
- package/dist/esm/connect/message.js +2 -0
- package/dist/esm/connect/socket.js +19 -6
- package/dist/esm/datasource/datasource.config.js +41 -0
- package/dist/esm/datasource/datasource.js +133 -58
- package/dist/esm/datasource/datasource.mixins.js +86 -0
- package/dist/esm/datasource/datasource.types.js +2 -18
- package/dist/esm/datasource/entityDatasource.js +6 -0
- package/dist/esm/datasource/index.js +2 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/resources/genesis/config.js +51 -0
- package/dist/esm/resources/genesis/genesis.js +114 -0
- package/dist/esm/resources/genesis/index.js +3 -0
- package/dist/esm/resources/genesis/types.js +4 -0
- package/dist/esm/resources/index.js +1 -0
- package/dist/esm/testing/mocks/auth/auth.js +10 -0
- package/dist/esm/testing/mocks/connect/connect.js +9 -2
- package/dist/esm/testing/mocks/connect/socket.js +2 -0
- package/dist/esm/testing/mocks/datasource/datasource.js +59 -0
- package/dist/esm/testing/mocks/index.js +1 -0
- package/dist/esm/testing/mocks/resources/genesis/genesis.js +25 -0
- package/dist/esm/testing/mocks/resources/genesis/index.js +1 -0
- package/dist/esm/testing/mocks/resources/index.js +1 -0
- package/dist/foundation-comms.api.json +11047 -6292
- package/dist/foundation-comms.d.ts +696 -37
- package/docs/api/foundation-comms.connect.connect.md +2 -2
- package/docs/api/foundation-comms.connect.getavailableresources.md +2 -2
- package/docs/api/foundation-comms.connect.host.md +11 -0
- package/docs/api/foundation-comms.connect.md +1 -0
- package/docs/api/foundation-comms.datasource.init.md +2 -2
- package/docs/api/foundation-comms.datasource.md +3 -2
- package/docs/api/{foundation-comms.datasource.fieldmetadata.md → foundation-comms.datasource.status.md} +3 -4
- package/docs/api/foundation-comms.datasourceconfig.eventemitter.md +18 -0
- package/docs/api/foundation-comms.datasourceconfig.md +2 -1
- package/docs/api/foundation-comms.datasourceeventhandler.md +353 -0
- package/docs/api/foundation-comms.datasourcemetadata.availableindexes.md +11 -0
- package/docs/api/foundation-comms.datasourcemetadata.fetchmetadatarequired.md +11 -0
- package/docs/api/foundation-comms.datasourcemetadata.fieldmetadata.md +11 -0
- package/docs/api/foundation-comms.datasourcemetadata.md +24 -0
- package/docs/api/foundation-comms.datasourcemetadata.originalfielddef.md +11 -0
- package/docs/api/foundation-comms.datasourcemetadata.requestfields.md +11 -0
- package/docs/api/foundation-comms.datasourcestatus.md +21 -0
- package/docs/api/foundation-comms.datasourcestatuschanged.md +13 -0
- package/docs/api/foundation-comms.datasourcestatuschangedevent.md +15 -0
- package/docs/api/foundation-comms.defaultconnect.connect.md +2 -2
- package/docs/api/foundation-comms.defaultconnect.getavailableresources.md +2 -2
- package/docs/api/foundation-comms.defaultconnect.host.md +11 -0
- package/docs/api/foundation-comms.defaultconnect.md +1 -0
- package/docs/api/foundation-comms.defaultdatasource._constructor_.md +3 -2
- package/docs/api/foundation-comms.defaultdatasource.availableindexes.md +2 -1
- package/docs/api/foundation-comms.defaultdatasource.fetchandapplymetadata.md +22 -0
- package/docs/api/{foundation-comms.defaultdatasource._stream.md → foundation-comms.defaultdatasource.fetchmetadatarequired.md} +4 -3
- package/docs/api/foundation-comms.defaultdatasource.fieldmetadata.md +1 -0
- package/docs/api/foundation-comms.defaultdatasource.initialized.md +3 -1
- package/docs/api/foundation-comms.defaultdatasource.md +10 -7
- package/docs/api/foundation-comms.defaultdatasource.originalfielddef.md +2 -1
- package/docs/api/foundation-comms.defaultdatasource.requestfields.md +2 -1
- package/docs/api/foundation-comms.defaultdatasource.resources.md +11 -0
- package/docs/api/foundation-comms.defaultdatasource.status.md +12 -0
- package/docs/api/foundation-comms.defaultdatasource.stream.md +1 -1
- package/docs/api/foundation-comms.defaultdatasource.validresourcename.md +5 -0
- package/docs/api/foundation-comms.defaultdatasourceconfig.md +1 -1
- package/docs/api/foundation-comms.defaultgenesisresources._constructor_.md +21 -0
- package/docs/api/foundation-comms.defaultgenesisresources.config.md +11 -0
- package/docs/api/foundation-comms.defaultgenesisresources.connect.md +11 -0
- package/docs/api/foundation-comms.defaultgenesisresources.destroy.md +17 -0
- package/docs/api/foundation-comms.defaultgenesisresources.getresources.md +15 -0
- package/docs/api/foundation-comms.defaultgenesisresources.getresourcetypefor.md +24 -0
- package/docs/api/foundation-comms.defaultgenesisresources.isvalidresource.md +24 -0
- package/docs/api/foundation-comms.defaultgenesisresources.md +40 -0
- package/docs/api/foundation-comms.defaultgenesisresources.postloadedmessage.md +15 -0
- package/docs/api/foundation-comms.defaultgenesisresources.resources.md +11 -0
- package/docs/api/foundation-comms.defaultgenesisresources.resourcespromise.md +11 -0
- package/docs/api/foundation-comms.defaultgenesisresourcesconfig.md +13 -0
- package/docs/api/foundation-comms.defaulthttpconnect.getavailableresources.md +2 -2
- package/docs/api/foundation-comms.defaultsocket._constructor_.md +2 -1
- package/docs/api/foundation-comms.defaultsocket.config.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.connect.md +2 -2
- package/docs/api/foundation-comms.defaultsocket.host.md +11 -0
- package/docs/api/foundation-comms.defaultsocket.md +3 -1
- package/docs/api/foundation-comms.eventmessagetype.md +2 -0
- package/docs/api/foundation-comms.genesisresources.destroy.md +13 -0
- package/docs/api/foundation-comms.genesisresources.getresourcetypefor.md +13 -0
- package/docs/api/foundation-comms.genesisresources.isvalidresource.md +13 -0
- package/docs/api/foundation-comms.genesisresources.md +26 -0
- package/docs/api/foundation-comms.genesisresourceschannel.md +33 -0
- package/docs/api/foundation-comms.genesisresourceschannelid.md +12 -0
- package/docs/api/foundation-comms.genesisresourcesconfig.md +21 -0
- package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunavailable.md +13 -0
- package/docs/api/foundation-comms.genesisresourcesconfig.throwwhenunknown.md +13 -0
- package/docs/api/foundation-comms.genesisresourcesevents.md +17 -0
- package/docs/api/foundation-comms.genesisresourcesmock.destroy.md +15 -0
- package/docs/api/foundation-comms.genesisresourcesmock.getresourcetypefor.md +24 -0
- package/docs/api/foundation-comms.genesisresourcesmock.isvalidresource.md +24 -0
- package/docs/api/foundation-comms.genesisresourcesmock.md +30 -0
- package/docs/api/foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md +11 -0
- package/docs/api/foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md +11 -0
- package/docs/api/foundation-comms.genesisresourcesmock.resources.md +11 -0
- package/docs/api/foundation-comms.getgenesisresources.md +30 -0
- package/docs/api/foundation-comms.getgenesisresourceschannel.md +39 -0
- package/docs/api/foundation-comms.md +19 -2
- package/docs/api/foundation-comms.resourceitem.md +15 -0
- package/docs/api/foundation-comms.resourcesmessage.md +18 -0
- package/docs/api/foundation-comms.socket.host.md +11 -0
- package/docs/api/foundation-comms.socket.md +6 -0
- package/docs/api-report.md +550 -25
- package/package.json +13 -12
|
@@ -9,14 +9,14 @@ Connects to a server at the specified host.
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
connect(host
|
|
12
|
+
connect(host?: string): Promise<boolean>;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
|
-
| host | string | The host to connect to. |
|
|
19
|
+
| host | string | _(Optional)_ The host to connect to. Defaults to . |
|
|
20
20
|
|
|
21
21
|
**Returns:**
|
|
22
22
|
|
|
@@ -9,7 +9,7 @@ Sends a request to the server to get available resources.
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
getAvailableResources(params?: RequestParams): Promise<
|
|
12
|
+
getAvailableResources(params?: RequestParams): Promise<ResourcesMessage>;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -20,7 +20,7 @@ getAvailableResources(params?: RequestParams): Promise<Message>;
|
|
|
20
20
|
|
|
21
21
|
**Returns:**
|
|
22
22
|
|
|
23
|
-
Promise<[
|
|
23
|
+
Promise<[ResourcesMessage](./foundation-comms.resourcesmessage.md)<!-- -->>
|
|
24
24
|
|
|
25
25
|
A promise that resolves to a Message containing the server's response with available resources.
|
|
26
26
|
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [Connect](./foundation-comms.connect.md) > [host](./foundation-comms.connect.host.md)
|
|
4
|
+
|
|
5
|
+
## Connect.host property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
host: string;
|
|
11
|
+
```
|
|
@@ -16,6 +16,7 @@ export interface Connect
|
|
|
16
16
|
|
|
17
17
|
| Property | Modifiers | Type | Description |
|
|
18
18
|
| --- | --- | --- | --- |
|
|
19
|
+
| [host](./foundation-comms.connect.host.md) | | string | |
|
|
19
20
|
| [isConnected](./foundation-comms.connect.isconnected.md) | <code>readonly</code> | boolean | Indicates whether the connection is currently established. |
|
|
20
21
|
| [isConnected$?](./foundation-comms.connect.isconnected_.md) | <code>readonly</code> | Observable<boolean> | _(Optional)_ An Observable that emits a boolean value indicating whether the connection is currently established. |
|
|
21
22
|
| [isConnectedSubject?](./foundation-comms.connect.isconnectedsubject.md) | <code>readonly</code> | BehaviorSubject<boolean> | _(Optional)_ A behavior subject holding the current connection status. |
|
|
@@ -9,7 +9,7 @@ Initializes the datasource with the given options and fetches metadata if specif
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
init(options: DatasourceOptions, fetchMeta
|
|
12
|
+
init(options: DatasourceOptions, fetchMeta?: boolean): Promise<boolean>;
|
|
13
13
|
```
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
@@ -17,7 +17,7 @@ init(options: DatasourceOptions, fetchMeta: boolean): Promise<boolean>;
|
|
|
17
17
|
| Parameter | Type | Description |
|
|
18
18
|
| --- | --- | --- |
|
|
19
19
|
| options | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | The options to initialize the datasource with. |
|
|
20
|
-
| fetchMeta | boolean |
|
|
20
|
+
| fetchMeta | boolean | _(Optional)_ Optional flag to fetch metadata for the datasource. Defaults to true. |
|
|
21
21
|
|
|
22
22
|
**Returns:**
|
|
23
23
|
|
|
@@ -9,8 +9,9 @@ Datasource interface.
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
11
11
|
```typescript
|
|
12
|
-
export interface Datasource
|
|
12
|
+
export interface Datasource extends DatasourceMetadata
|
|
13
13
|
```
|
|
14
|
+
**Extends:** [DatasourceMetadata](./foundation-comms.datasourcemetadata.md)
|
|
14
15
|
|
|
15
16
|
## Remarks
|
|
16
17
|
|
|
@@ -20,10 +21,10 @@ The public interface available on the injected store fragment.
|
|
|
20
21
|
|
|
21
22
|
| Property | Modifiers | Type | Description |
|
|
22
23
|
| --- | --- | --- | --- |
|
|
23
|
-
| [fieldMetadata](./foundation-comms.datasource.fieldmetadata.md) | | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | Metadata about the fields of the datasource. |
|
|
24
24
|
| [initialized](./foundation-comms.datasource.initialized.md) | | boolean | Indicates whether the datasource has been initialized. |
|
|
25
25
|
| [readOnly](./foundation-comms.datasource.readonly.md) | | boolean | Indicates whether the datasource is read-only. TODO: Should have is prefix |
|
|
26
26
|
| [resourceType](./foundation-comms.datasource.resourcetype.md) | | [ResourceType](./foundation-comms.resourcetype.md) | The type of resource the datasource represents. |
|
|
27
|
+
| [status](./foundation-comms.datasource.status.md) | | Partial<[DatasourceStatus](./foundation-comms.datasourcestatus.md)<!-- -->> | |
|
|
27
28
|
| [stream](./foundation-comms.datasource.stream.md) | | [SocketObservable](./foundation-comms.socketobservable.md)<!-- --><[FilteredDataServerResult](./foundation-comms.filtereddataserverresult.md) \| [RequestServerResult](./foundation-comms.requestserverresult.md)<!-- -->> | A stream of data from the datasource. |
|
|
28
29
|
|
|
29
30
|
## Methods
|
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
2
|
|
|
3
|
-
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [Datasource](./foundation-comms.datasource.md) > [
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [Datasource](./foundation-comms.datasource.md) > [status](./foundation-comms.datasource.status.md)
|
|
4
4
|
|
|
5
|
-
## Datasource.
|
|
5
|
+
## Datasource.status property
|
|
6
6
|
|
|
7
|
-
Metadata about the fields of the datasource.
|
|
8
7
|
|
|
9
8
|
**Signature:**
|
|
10
9
|
|
|
11
10
|
```typescript
|
|
12
|
-
|
|
11
|
+
status: Partial<DatasourceStatus>;
|
|
13
12
|
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceConfig](./foundation-comms.datasourceconfig.md) > [eventEmitter](./foundation-comms.datasourceconfig.eventemitter.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceConfig.eventEmitter property
|
|
6
|
+
|
|
7
|
+
The element to emit events from.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
eventEmitter?: HTMLElement;
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Remarks
|
|
16
|
+
|
|
17
|
+
If omitted the document is used.
|
|
18
|
+
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
## DatasourceConfig interface
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
DatasourceConfig DI interface.
|
|
8
8
|
|
|
9
9
|
**Signature:**
|
|
10
10
|
|
|
@@ -16,6 +16,7 @@ export interface DatasourceConfig
|
|
|
16
16
|
|
|
17
17
|
| Property | Modifiers | Type | Description |
|
|
18
18
|
| --- | --- | --- | --- |
|
|
19
|
+
| [eventEmitter?](./foundation-comms.datasourceconfig.eventemitter.md) | | HTMLElement | _(Optional)_ The element to emit events from. |
|
|
19
20
|
| [options](./foundation-comms.datasourceconfig.options.md) | | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | |
|
|
20
21
|
|
|
21
22
|
## Methods
|
|
@@ -0,0 +1,353 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceEventHandler variable
|
|
6
|
+
|
|
7
|
+
Datasource event handler mixin for target classes that use or are interested in datasource status changes.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
13
|
+
new (): {
|
|
14
|
+
datasourceStatus: DatasourceStatus;
|
|
15
|
+
resourceName: string;
|
|
16
|
+
onDatasourceStatusChanged: (event: DatasourceStatusChangedEvent) => void;
|
|
17
|
+
datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus): void;
|
|
18
|
+
connectedCallback(): void;
|
|
19
|
+
disconnectedCallback(): void;
|
|
20
|
+
accessKey: string;
|
|
21
|
+
readonly accessKeyLabel: string;
|
|
22
|
+
autocapitalize: string;
|
|
23
|
+
dir: string;
|
|
24
|
+
draggable: boolean;
|
|
25
|
+
hidden: boolean;
|
|
26
|
+
inert: boolean;
|
|
27
|
+
innerText: string;
|
|
28
|
+
lang: string;
|
|
29
|
+
readonly offsetHeight: number;
|
|
30
|
+
readonly offsetLeft: number;
|
|
31
|
+
readonly offsetParent: Element;
|
|
32
|
+
readonly offsetTop: number;
|
|
33
|
+
readonly offsetWidth: number;
|
|
34
|
+
outerText: string;
|
|
35
|
+
spellcheck: boolean;
|
|
36
|
+
title: string;
|
|
37
|
+
translate: boolean;
|
|
38
|
+
attachInternals(): ElementInternals;
|
|
39
|
+
click(): void;
|
|
40
|
+
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
|
41
|
+
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
|
42
|
+
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
|
43
|
+
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
|
|
44
|
+
readonly attributes: NamedNodeMap;
|
|
45
|
+
readonly classList: DOMTokenList;
|
|
46
|
+
className: string;
|
|
47
|
+
readonly clientHeight: number;
|
|
48
|
+
readonly clientLeft: number;
|
|
49
|
+
readonly clientTop: number;
|
|
50
|
+
readonly clientWidth: number;
|
|
51
|
+
id: string;
|
|
52
|
+
readonly localName: string;
|
|
53
|
+
readonly namespaceURI: string;
|
|
54
|
+
onfullscreenchange: (this: Element, ev: Event) => any;
|
|
55
|
+
onfullscreenerror: (this: Element, ev: Event) => any;
|
|
56
|
+
outerHTML: string;
|
|
57
|
+
readonly ownerDocument: Document;
|
|
58
|
+
readonly part: DOMTokenList;
|
|
59
|
+
readonly prefix: string;
|
|
60
|
+
readonly scrollHeight: number;
|
|
61
|
+
scrollLeft: number;
|
|
62
|
+
scrollTop: number;
|
|
63
|
+
readonly scrollWidth: number;
|
|
64
|
+
readonly shadowRoot: ShadowRoot;
|
|
65
|
+
slot: string;
|
|
66
|
+
readonly tagName: string;
|
|
67
|
+
attachShadow(init: ShadowRootInit): ShadowRoot;
|
|
68
|
+
closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
|
|
69
|
+
closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
|
|
70
|
+
closest<E extends Element = Element>(selectors: string): E;
|
|
71
|
+
getAttribute(qualifiedName: string): string;
|
|
72
|
+
getAttributeNS(namespace: string, localName: string): string;
|
|
73
|
+
getAttributeNames(): string[];
|
|
74
|
+
getAttributeNode(qualifiedName: string): Attr;
|
|
75
|
+
getAttributeNodeNS(namespace: string, localName: string): Attr;
|
|
76
|
+
getBoundingClientRect(): DOMRect;
|
|
77
|
+
getClientRects(): DOMRectList;
|
|
78
|
+
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
|
79
|
+
getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
|
|
80
|
+
getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
|
|
81
|
+
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
|
82
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
|
83
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
|
84
|
+
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
|
85
|
+
hasAttribute(qualifiedName: string): boolean;
|
|
86
|
+
hasAttributeNS(namespace: string, localName: string): boolean;
|
|
87
|
+
hasAttributes(): boolean;
|
|
88
|
+
hasPointerCapture(pointerId: number): boolean;
|
|
89
|
+
insertAdjacentElement(where: InsertPosition, element: Element): Element;
|
|
90
|
+
insertAdjacentHTML(position: InsertPosition, text: string): void;
|
|
91
|
+
insertAdjacentText(where: InsertPosition, data: string): void;
|
|
92
|
+
matches(selectors: string): boolean;
|
|
93
|
+
releasePointerCapture(pointerId: number): void;
|
|
94
|
+
removeAttribute(qualifiedName: string): void;
|
|
95
|
+
removeAttributeNS(namespace: string, localName: string): void;
|
|
96
|
+
removeAttributeNode(attr: Attr): Attr;
|
|
97
|
+
requestFullscreen(options?: FullscreenOptions): Promise<void>;
|
|
98
|
+
requestPointerLock(): void;
|
|
99
|
+
scroll(options?: ScrollToOptions): void;
|
|
100
|
+
scroll(x: number, y: number): void;
|
|
101
|
+
scrollBy(options?: ScrollToOptions): void;
|
|
102
|
+
scrollBy(x: number, y: number): void;
|
|
103
|
+
scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void;
|
|
104
|
+
scrollTo(options?: ScrollToOptions): void;
|
|
105
|
+
scrollTo(x: number, y: number): void;
|
|
106
|
+
setAttribute(qualifiedName: string, value: string): void;
|
|
107
|
+
setAttributeNS(namespace: string, qualifiedName: string, value: string): void;
|
|
108
|
+
setAttributeNode(attr: Attr): Attr;
|
|
109
|
+
setAttributeNodeNS(attr: Attr): Attr;
|
|
110
|
+
setPointerCapture(pointerId: number): void;
|
|
111
|
+
toggleAttribute(qualifiedName: string, force?: boolean): boolean;
|
|
112
|
+
webkitMatchesSelector(selectors: string): boolean;
|
|
113
|
+
readonly baseURI: string;
|
|
114
|
+
readonly childNodes: NodeListOf<ChildNode>;
|
|
115
|
+
readonly firstChild: ChildNode;
|
|
116
|
+
readonly isConnected: boolean;
|
|
117
|
+
readonly lastChild: ChildNode;
|
|
118
|
+
readonly nextSibling: ChildNode;
|
|
119
|
+
readonly nodeName: string;
|
|
120
|
+
readonly nodeType: number;
|
|
121
|
+
nodeValue: string;
|
|
122
|
+
readonly parentElement: HTMLElement;
|
|
123
|
+
readonly parentNode: ParentNode;
|
|
124
|
+
readonly previousSibling: ChildNode;
|
|
125
|
+
textContent: string;
|
|
126
|
+
appendChild<T extends Node>(node: T): T;
|
|
127
|
+
cloneNode(deep?: boolean): Node;
|
|
128
|
+
compareDocumentPosition(other: Node): number;
|
|
129
|
+
contains(other: Node): boolean;
|
|
130
|
+
getRootNode(options?: GetRootNodeOptions): Node;
|
|
131
|
+
hasChildNodes(): boolean;
|
|
132
|
+
insertBefore<T_1 extends Node>(node: T_1, child: Node): T_1;
|
|
133
|
+
isDefaultNamespace(namespace: string): boolean;
|
|
134
|
+
isEqualNode(otherNode: Node): boolean;
|
|
135
|
+
isSameNode(otherNode: Node): boolean;
|
|
136
|
+
lookupNamespaceURI(prefix: string): string;
|
|
137
|
+
lookupPrefix(namespace: string): string;
|
|
138
|
+
normalize(): void;
|
|
139
|
+
removeChild<T_2 extends Node>(child: T_2): T_2;
|
|
140
|
+
replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
|
|
141
|
+
readonly ATTRIBUTE_NODE: number;
|
|
142
|
+
readonly CDATA_SECTION_NODE: number;
|
|
143
|
+
readonly COMMENT_NODE: number;
|
|
144
|
+
readonly DOCUMENT_FRAGMENT_NODE: number;
|
|
145
|
+
readonly DOCUMENT_NODE: number;
|
|
146
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: number;
|
|
147
|
+
readonly DOCUMENT_POSITION_CONTAINS: number;
|
|
148
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: number;
|
|
149
|
+
readonly DOCUMENT_POSITION_FOLLOWING: number;
|
|
150
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
|
|
151
|
+
readonly DOCUMENT_POSITION_PRECEDING: number;
|
|
152
|
+
readonly DOCUMENT_TYPE_NODE: number;
|
|
153
|
+
readonly ELEMENT_NODE: number;
|
|
154
|
+
readonly ENTITY_NODE: number;
|
|
155
|
+
readonly ENTITY_REFERENCE_NODE: number;
|
|
156
|
+
readonly NOTATION_NODE: number;
|
|
157
|
+
readonly PROCESSING_INSTRUCTION_NODE: number;
|
|
158
|
+
readonly TEXT_NODE: number;
|
|
159
|
+
dispatchEvent(event: Event): boolean;
|
|
160
|
+
ariaAtomic: string;
|
|
161
|
+
ariaAutoComplete: string;
|
|
162
|
+
ariaBusy: string;
|
|
163
|
+
ariaChecked: string;
|
|
164
|
+
ariaColCount: string;
|
|
165
|
+
ariaColIndex: string;
|
|
166
|
+
ariaColIndexText: string;
|
|
167
|
+
ariaColSpan: string;
|
|
168
|
+
ariaCurrent: string;
|
|
169
|
+
ariaDisabled: string;
|
|
170
|
+
ariaExpanded: string;
|
|
171
|
+
ariaHasPopup: string;
|
|
172
|
+
ariaHidden: string;
|
|
173
|
+
ariaInvalid: string;
|
|
174
|
+
ariaKeyShortcuts: string;
|
|
175
|
+
ariaLabel: string;
|
|
176
|
+
ariaLevel: string;
|
|
177
|
+
ariaLive: string;
|
|
178
|
+
ariaModal: string;
|
|
179
|
+
ariaMultiLine: string;
|
|
180
|
+
ariaMultiSelectable: string;
|
|
181
|
+
ariaOrientation: string;
|
|
182
|
+
ariaPlaceholder: string;
|
|
183
|
+
ariaPosInSet: string;
|
|
184
|
+
ariaPressed: string;
|
|
185
|
+
ariaReadOnly: string;
|
|
186
|
+
ariaRequired: string;
|
|
187
|
+
ariaRoleDescription: string;
|
|
188
|
+
ariaRowCount: string;
|
|
189
|
+
ariaRowIndex: string;
|
|
190
|
+
ariaRowIndexText: string;
|
|
191
|
+
ariaRowSpan: string;
|
|
192
|
+
ariaSelected: string;
|
|
193
|
+
ariaSetSize: string;
|
|
194
|
+
ariaSort: string;
|
|
195
|
+
ariaValueMax: string;
|
|
196
|
+
ariaValueMin: string;
|
|
197
|
+
ariaValueNow: string;
|
|
198
|
+
ariaValueText: string;
|
|
199
|
+
role: string;
|
|
200
|
+
animate(keyframes: Keyframe[] | PropertyIndexedKeyframes, options?: number | KeyframeAnimationOptions): Animation;
|
|
201
|
+
getAnimations(options?: GetAnimationsOptions): Animation[];
|
|
202
|
+
after(...nodes: (string | Node)[]): void;
|
|
203
|
+
before(...nodes: (string | Node)[]): void;
|
|
204
|
+
remove(): void;
|
|
205
|
+
replaceWith(...nodes: (string | Node)[]): void;
|
|
206
|
+
innerHTML: string;
|
|
207
|
+
readonly nextElementSibling: Element;
|
|
208
|
+
readonly previousElementSibling: Element;
|
|
209
|
+
readonly childElementCount: number;
|
|
210
|
+
readonly children: HTMLCollection;
|
|
211
|
+
readonly firstElementChild: Element;
|
|
212
|
+
readonly lastElementChild: Element;
|
|
213
|
+
append(...nodes: (string | Node)[]): void;
|
|
214
|
+
prepend(...nodes: (string | Node)[]): void;
|
|
215
|
+
querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
|
|
216
|
+
querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
|
|
217
|
+
querySelector<E_1 extends Element = Element>(selectors: string): E_1;
|
|
218
|
+
querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
|
|
219
|
+
querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
|
|
220
|
+
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
|
|
221
|
+
replaceChildren(...nodes: (string | Node)[]): void;
|
|
222
|
+
readonly assignedSlot: HTMLSlotElement;
|
|
223
|
+
oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
224
|
+
oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
225
|
+
onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
|
226
|
+
readonly style: CSSStyleDeclaration;
|
|
227
|
+
contentEditable: string;
|
|
228
|
+
enterKeyHint: string;
|
|
229
|
+
inputMode: string;
|
|
230
|
+
readonly isContentEditable: boolean;
|
|
231
|
+
onabort: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
232
|
+
onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
233
|
+
onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
234
|
+
onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
235
|
+
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
|
236
|
+
onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
237
|
+
onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
|
|
238
|
+
onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
|
239
|
+
oncancel: (this: GlobalEventHandlers, ev: Event) => any;
|
|
240
|
+
oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
|
|
241
|
+
oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any;
|
|
242
|
+
onchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
243
|
+
onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
244
|
+
onclose: (this: GlobalEventHandlers, ev: Event) => any;
|
|
245
|
+
oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
246
|
+
oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
247
|
+
ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
248
|
+
ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
249
|
+
ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
250
|
+
ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
251
|
+
ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
252
|
+
ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
253
|
+
ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
254
|
+
ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
|
255
|
+
ondurationchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
256
|
+
onemptied: (this: GlobalEventHandlers, ev: Event) => any;
|
|
257
|
+
onended: (this: GlobalEventHandlers, ev: Event) => any;
|
|
258
|
+
onerror: OnErrorEventHandlerNonNull;
|
|
259
|
+
onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
|
260
|
+
onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any;
|
|
261
|
+
ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
262
|
+
oninput: (this: GlobalEventHandlers, ev: Event) => any;
|
|
263
|
+
oninvalid: (this: GlobalEventHandlers, ev: Event) => any;
|
|
264
|
+
onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
265
|
+
onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
266
|
+
onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any;
|
|
267
|
+
onload: (this: GlobalEventHandlers, ev: Event) => any;
|
|
268
|
+
onloadeddata: (this: GlobalEventHandlers, ev: Event) => any;
|
|
269
|
+
onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any;
|
|
270
|
+
onloadstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
271
|
+
onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
272
|
+
onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
273
|
+
onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
274
|
+
onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
275
|
+
onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
276
|
+
onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
277
|
+
onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
278
|
+
onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
|
279
|
+
onpause: (this: GlobalEventHandlers, ev: Event) => any;
|
|
280
|
+
onplay: (this: GlobalEventHandlers, ev: Event) => any;
|
|
281
|
+
onplaying: (this: GlobalEventHandlers, ev: Event) => any;
|
|
282
|
+
onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
283
|
+
onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
284
|
+
onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
285
|
+
onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
286
|
+
onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
287
|
+
onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
288
|
+
onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
289
|
+
onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any;
|
|
290
|
+
onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any;
|
|
291
|
+
onratechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
292
|
+
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
|
293
|
+
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
|
294
|
+
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
|
295
|
+
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
|
296
|
+
onseeked: (this: GlobalEventHandlers, ev: Event) => any;
|
|
297
|
+
onseeking: (this: GlobalEventHandlers, ev: Event) => any;
|
|
298
|
+
onselect: (this: GlobalEventHandlers, ev: Event) => any;
|
|
299
|
+
onselectionchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
300
|
+
onselectstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
301
|
+
onslotchange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
302
|
+
onstalled: (this: GlobalEventHandlers, ev: Event) => any;
|
|
303
|
+
onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any;
|
|
304
|
+
onsuspend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
305
|
+
ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any;
|
|
306
|
+
ontoggle: (this: GlobalEventHandlers, ev: Event) => any;
|
|
307
|
+
ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
308
|
+
ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
309
|
+
ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
310
|
+
ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any;
|
|
311
|
+
ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
312
|
+
ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
313
|
+
ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
314
|
+
ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any;
|
|
315
|
+
onvolumechange: (this: GlobalEventHandlers, ev: Event) => any;
|
|
316
|
+
onwaiting: (this: GlobalEventHandlers, ev: Event) => any;
|
|
317
|
+
onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
318
|
+
onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any;
|
|
319
|
+
onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any;
|
|
320
|
+
onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any;
|
|
321
|
+
onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any;
|
|
322
|
+
autofocus: boolean;
|
|
323
|
+
readonly dataset: DOMStringMap;
|
|
324
|
+
nonce?: string;
|
|
325
|
+
tabIndex: number;
|
|
326
|
+
blur(): void;
|
|
327
|
+
focus(options?: FocusOptions): void;
|
|
328
|
+
readonly $fastController: import("@microsoft/fast-element").Controller;
|
|
329
|
+
$emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean | void;
|
|
330
|
+
attributeChangedCallback(name: string, oldValue: string, newValue: string): void;
|
|
331
|
+
};
|
|
332
|
+
}
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
## Remarks
|
|
336
|
+
|
|
337
|
+
Classes that use the mixin are not required to own the datasource itself, there may be several interested parties.
|
|
338
|
+
|
|
339
|
+
## Example
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
```ts
|
|
343
|
+
import { DatasourceEventHandler, DatasourceStatus } from '@genesislcap/foundation-comms';
|
|
344
|
+
...
|
|
345
|
+
class MyComponent extends DatasourceEventHandler(FASTElement) {
|
|
346
|
+
resourceName: string = 'some-resource';
|
|
347
|
+
...
|
|
348
|
+
datasourceStatusChanged(prev: DatasourceStatus, next: DatasourceStatus) {
|
|
349
|
+
// Respond to changes in the target datasource.
|
|
350
|
+
}
|
|
351
|
+
}
|
|
352
|
+
```
|
|
353
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) > [availableIndexes](./foundation-comms.datasourcemetadata.availableindexes.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceMetadata.availableIndexes property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly availableIndexes: IndexDetail[];
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) > [fetchMetadataRequired](./foundation-comms.datasourcemetadata.fetchmetadatarequired.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceMetadata.fetchMetadataRequired property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
fetchMetadataRequired: boolean;
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) > [fieldMetadata](./foundation-comms.datasourcemetadata.fieldmetadata.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceMetadata.fieldMetadata property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly fieldMetadata: FieldMetadata[];
|
|
11
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceMetadata](./foundation-comms.datasourcemetadata.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceMetadata interface
|
|
6
|
+
|
|
7
|
+
DatasourceMetadata interface.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export interface DatasourceMetadata
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
| Property | Modifiers | Type | Description |
|
|
18
|
+
| --- | --- | --- | --- |
|
|
19
|
+
| [availableIndexes](./foundation-comms.datasourcemetadata.availableindexes.md) | <code>readonly</code> | [IndexDetail](./foundation-comms.indexdetail.md)<!-- -->\[\] | |
|
|
20
|
+
| [fetchMetadataRequired](./foundation-comms.datasourcemetadata.fetchmetadatarequired.md) | | boolean | |
|
|
21
|
+
| [fieldMetadata](./foundation-comms.datasourcemetadata.fieldmetadata.md) | <code>readonly</code> | [FieldMetadata](./foundation-comms.fieldmetadata.md)<!-- -->\[\] | |
|
|
22
|
+
| [originalFieldDef](./foundation-comms.datasourcemetadata.originalfielddef.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
|
|
23
|
+
| [requestFields](./foundation-comms.datasourcemetadata.requestfields.md) | <code>readonly</code> | [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\] | |
|
|
24
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) > [originalFieldDef](./foundation-comms.datasourcemetadata.originalfielddef.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceMetadata.originalFieldDef property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly originalFieldDef: MetadataDetail[];
|
|
11
|
+
```
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceMetadata](./foundation-comms.datasourcemetadata.md) > [requestFields](./foundation-comms.datasourcemetadata.requestfields.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceMetadata.requestFields property
|
|
6
|
+
|
|
7
|
+
**Signature:**
|
|
8
|
+
|
|
9
|
+
```typescript
|
|
10
|
+
readonly requestFields: MetadataDetail[];
|
|
11
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceStatus](./foundation-comms.datasourcestatus.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceStatus type
|
|
6
|
+
|
|
7
|
+
DatasourceStatus.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export type DatasourceStatus = {
|
|
13
|
+
name: string;
|
|
14
|
+
type: `${ResourceType}`;
|
|
15
|
+
isInitialized: boolean;
|
|
16
|
+
metadataRequired: boolean;
|
|
17
|
+
hasMetadata: boolean;
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
**References:** [ResourceType](./foundation-comms.resourcetype.md)
|
|
21
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceStatusChanged](./foundation-comms.datasourcestatuschanged.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceStatusChanged variable
|
|
6
|
+
|
|
7
|
+
DatasourceStatusChanged.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
DatasourceStatusChanged = "datasource-status-changed"
|
|
13
|
+
```
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
2
|
+
|
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceStatusChangedEvent](./foundation-comms.datasourcestatuschangedevent.md)
|
|
4
|
+
|
|
5
|
+
## DatasourceStatusChangedEvent type
|
|
6
|
+
|
|
7
|
+
DatasourceStatusChangedEvent.
|
|
8
|
+
|
|
9
|
+
**Signature:**
|
|
10
|
+
|
|
11
|
+
```typescript
|
|
12
|
+
export type DatasourceStatusChangedEvent = CustomEvent<DatasourceStatus>;
|
|
13
|
+
```
|
|
14
|
+
**References:** [DatasourceStatus](./foundation-comms.datasourcestatus.md)
|
|
15
|
+
|