@genesislcap/foundation-comms 14.225.3 → 14.225.4-alpha-9342136.0
Sign up to get free protection for your applications and to get access to all the features.
- package/dist/dts/datasource/datasource.mixins.d.ts +45 -29
- package/dist/dts/datasource/datasource.mixins.d.ts.map +1 -1
- package/dist/dts/testing/mocks/auth/auth.d.ts +1 -1
- package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
- package/dist/dts/testing/mocks/connect/socket.d.ts +1 -1
- package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
- package/dist/dts/tsdoc-metadata.json +1 -1
- package/dist/esm/auth/auth.js +2 -2
- package/dist/esm/connect/connect.js +8 -8
- package/dist/esm/connect/http.connect.js +8 -7
- package/dist/esm/connect/socket.js +1 -5
- package/dist/esm/credentialManager/credentialManager.js +2 -2
- package/dist/esm/datasource/datasource.js +7 -7
- package/dist/esm/networkMonitor/config.js +1 -2
- package/dist/esm/resources/genesis/genesis.js +1 -1
- package/dist/esm/storage/kv/kv.service.js +3 -3
- package/dist/foundation-comms.api.json +4898 -2404
- package/dist/foundation-comms.d.ts +47 -31
- package/docs/api/foundation-comms.connect.md +1 -0
- package/docs/api/foundation-comms.connect.streamwithoutautoteardown.md +37 -0
- package/docs/api/foundation-comms.datasourceeventhandler.md +56 -30
- package/docs/api/foundation-comms.defaultentitydatasource._initialized.md +15 -0
- package/docs/api/foundation-comms.defaultentitydatasource.cache.md +19 -0
- package/docs/api/foundation-comms.defaultentitydatasource.disconnect.md +19 -0
- package/docs/api/foundation-comms.defaultentitydatasource.entitycache.md +14 -0
- package/docs/api/foundation-comms.defaultentitydatasource.entitymap.md +14 -0
- package/docs/api/foundation-comms.defaultentitydatasource.initialize.md +19 -0
- package/docs/api/foundation-comms.defaultentitydatasource.initialized.md +16 -0
- package/docs/api/foundation-comms.defaultentitydatasource.isempty.md +19 -0
- package/docs/api/foundation-comms.defaultentitydatasource.mapper.md +14 -0
- package/docs/api/foundation-comms.defaultentitydatasource.md +38 -0
- package/docs/api/foundation-comms.defaultentitydatasource.rowid.md +14 -0
- package/docs/api/foundation-comms.defaultentitydatasource.sourceref.md +14 -0
- package/docs/api/foundation-comms.defaultentitydatasource.subscription.md +14 -0
- package/docs/api/foundation-comms.defaultentitydatasource.subscriptionloggedoff.md +14 -0
- package/docs/api/foundation-comms.defaultkvstorage._constructor_.md +25 -0
- package/docs/api/foundation-comms.defaultkvstorage.md +30 -0
- package/docs/api/foundation-comms.defaultkvstorage.user.md +14 -0
- package/docs/api/foundation-comms.defaultkvstorageconfig.md +16 -0
- package/docs/api/foundation-comms.entitydatasource.cache.md +19 -0
- package/docs/api/foundation-comms.entitydatasource.disconnect.md +22 -0
- package/docs/api/foundation-comms.entitydatasource.initialize.md +29 -0
- package/docs/api/foundation-comms.entitydatasource.isempty.md +19 -0
- package/docs/api/foundation-comms.entitydatasource.md +81 -0
- package/docs/api/foundation-comms.entitydatasourceinit.fetchmeta.md +14 -0
- package/docs/api/foundation-comms.entitydatasourceinit.mapper.md +14 -0
- package/docs/api/foundation-comms.entitydatasourceinit.md +25 -0
- package/docs/api/foundation-comms.entitydatasourceinit.options.md +14 -0
- package/docs/api/foundation-comms.extractfielddefinitions.md +14 -1
- package/docs/api/foundation-comms.getkvstorage.md +1 -1
- package/docs/api/foundation-comms.keyvalue.base64.md +16 -0
- package/docs/api/foundation-comms.keyvalue.expiration.md +16 -0
- package/docs/api/foundation-comms.keyvalue.key.md +16 -0
- package/docs/api/foundation-comms.keyvalue.md +27 -0
- package/docs/api/foundation-comms.keyvalue.metadata.md +18 -0
- package/docs/api/foundation-comms.keyvalue.value.md +16 -0
- package/docs/api/foundation-comms.keyvaluetransfer.deserialize.md +25 -0
- package/docs/api/foundation-comms.keyvaluetransfer.kv.md +14 -0
- package/docs/api/foundation-comms.keyvaluetransfer.md +30 -0
- package/docs/api/foundation-comms.keyvaluetransfer.serialize.md +25 -0
- package/docs/api/foundation-comms.kveventfailureresponse.md +21 -0
- package/docs/api/foundation-comms.kveventmessagetype.md +24 -0
- package/docs/api/foundation-comms.kvmessagetype.md +24 -0
- package/docs/api/foundation-comms.kvstorage.delete.md +25 -0
- package/docs/api/foundation-comms.kvstorage.get.md +18 -0
- package/docs/api/foundation-comms.kvstorage.get_1.md +25 -0
- package/docs/api/foundation-comms.kvstorage.list.md +18 -0
- package/docs/api/foundation-comms.kvstorage.md +31 -0
- package/docs/api/foundation-comms.kvstorage.put.md +25 -0
- package/docs/api/foundation-comms.kvstorageconfig.account.md +16 -0
- package/docs/api/foundation-comms.kvstorageconfig.authemail.md +21 -0
- package/docs/api/foundation-comms.kvstorageconfig.authkey.md +16 -0
- package/docs/api/foundation-comms.kvstorageconfig.md +26 -0
- package/docs/api/foundation-comms.kvstorageconfig.namespace.md +16 -0
- package/docs/api/foundation-comms.kvvalue.md +16 -0
- package/docs/api/foundation-comms.md +19 -6
- package/docs/api/foundation-comms.messagehaserrorcode.md +13 -1
- package/docs/api/foundation-comms.messageorthrow.md +14 -1
- package/docs/api/foundation-comms.retryinterval.md +15 -1
- package/docs/api/foundation-comms.socket.md +1 -0
- package/docs/api/foundation-comms.socket.sendforstreamwithoutteardown.md +31 -0
- package/docs/api/foundation-comms.tofieldmetadata.md +14 -1
- package/docs/{api-report.md → api-report.md.api.md} +47 -31
- package/package.json +14 -14
@@ -15,7 +15,7 @@ import type { LogLevel } from '@genesislcap/foundation-utils';
|
|
15
15
|
import { Observable } from 'rxjs';
|
16
16
|
import { Observer } from '@genesislcap/foundation-utils';
|
17
17
|
import { Observer as Observer_2 } from 'rxjs';
|
18
|
-
import { SetUserProperties } from '@genesislcap/foundation-user
|
18
|
+
import { SetUserProperties } from '@genesislcap/foundation-user';
|
19
19
|
import { Subscription as SocketSubscription } from 'rxjs';
|
20
20
|
import { Subject } from 'rxjs';
|
21
21
|
import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
|
@@ -1104,11 +1104,15 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1104
1104
|
readonly offsetTop: number;
|
1105
1105
|
readonly offsetWidth: number;
|
1106
1106
|
outerText: string;
|
1107
|
+
popover: string;
|
1107
1108
|
spellcheck: boolean;
|
1108
1109
|
title: string;
|
1109
1110
|
translate: boolean;
|
1110
1111
|
attachInternals(): ElementInternals;
|
1111
1112
|
click(): void;
|
1113
|
+
hidePopover(): void;
|
1114
|
+
showPopover(): void;
|
1115
|
+
togglePopover(force?: boolean): boolean;
|
1112
1116
|
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
1113
1117
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
1114
1118
|
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
@@ -1137,9 +1141,12 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1137
1141
|
slot: string;
|
1138
1142
|
readonly tagName: string;
|
1139
1143
|
attachShadow(init: ShadowRootInit): ShadowRoot;
|
1144
|
+
checkVisibility(options?: CheckVisibilityOptions): boolean;
|
1140
1145
|
closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
|
1141
1146
|
closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
|
1147
|
+
closest<K_4 extends keyof MathMLElementTagNameMap>(selector: K_4): MathMLElementTagNameMap[K_4];
|
1142
1148
|
closest<E extends Element = Element>(selectors: string): E;
|
1149
|
+
computedStyleMap(): StylePropertyMapReadOnly;
|
1143
1150
|
getAttribute(qualifiedName: string): string;
|
1144
1151
|
getAttributeNS(namespace: string, localName: string): string;
|
1145
1152
|
getAttributeNames(): string[];
|
@@ -1148,11 +1155,14 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1148
1155
|
getBoundingClientRect(): DOMRect;
|
1149
1156
|
getClientRects(): DOMRectList;
|
1150
1157
|
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
1151
|
-
getElementsByTagName<
|
1152
|
-
getElementsByTagName<
|
1158
|
+
getElementsByTagName<K_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<HTMLElementTagNameMap[K_5]>;
|
1159
|
+
getElementsByTagName<K_6 extends keyof SVGElementTagNameMap>(qualifiedName: K_6): HTMLCollectionOf<SVGElementTagNameMap[K_6]>;
|
1160
|
+
getElementsByTagName<K_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K_7): HTMLCollectionOf<MathMLElementTagNameMap[K_7]>;
|
1161
|
+
getElementsByTagName<K_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K_8]>;
|
1153
1162
|
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
1154
1163
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
1155
1164
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
1165
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
|
1156
1166
|
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
1157
1167
|
hasAttribute(qualifiedName: string): boolean;
|
1158
1168
|
hasAttributeNS(namespace: string, localName: string): boolean;
|
@@ -1210,24 +1220,24 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1210
1220
|
normalize(): void;
|
1211
1221
|
removeChild<T_2 extends Node>(child: T_2): T_2;
|
1212
1222
|
replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
|
1213
|
-
readonly
|
1214
|
-
readonly
|
1215
|
-
readonly
|
1216
|
-
readonly
|
1217
|
-
readonly
|
1218
|
-
readonly
|
1219
|
-
readonly
|
1220
|
-
readonly
|
1221
|
-
readonly
|
1222
|
-
readonly
|
1223
|
-
readonly
|
1224
|
-
readonly
|
1225
|
-
readonly
|
1226
|
-
readonly
|
1227
|
-
readonly
|
1228
|
-
readonly
|
1229
|
-
readonly
|
1230
|
-
readonly
|
1223
|
+
readonly ELEMENT_NODE: 1;
|
1224
|
+
readonly ATTRIBUTE_NODE: 2;
|
1225
|
+
readonly TEXT_NODE: 3;
|
1226
|
+
readonly CDATA_SECTION_NODE: 4;
|
1227
|
+
readonly ENTITY_REFERENCE_NODE: 5;
|
1228
|
+
readonly ENTITY_NODE: 6;
|
1229
|
+
readonly PROCESSING_INSTRUCTION_NODE: 7;
|
1230
|
+
readonly COMMENT_NODE: 8;
|
1231
|
+
readonly DOCUMENT_NODE: 9;
|
1232
|
+
readonly DOCUMENT_TYPE_NODE: 10;
|
1233
|
+
readonly DOCUMENT_FRAGMENT_NODE: 11;
|
1234
|
+
readonly NOTATION_NODE: 12;
|
1235
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: 1;
|
1236
|
+
readonly DOCUMENT_POSITION_PRECEDING: 2;
|
1237
|
+
readonly DOCUMENT_POSITION_FOLLOWING: 4;
|
1238
|
+
readonly DOCUMENT_POSITION_CONTAINS: 8;
|
1239
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
|
1240
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
|
1231
1241
|
dispatchEvent(event: Event): boolean;
|
1232
1242
|
ariaAtomic: string;
|
1233
1243
|
ariaAutoComplete: string;
|
@@ -1235,9 +1245,9 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1235
1245
|
ariaChecked: string;
|
1236
1246
|
ariaColCount: string;
|
1237
1247
|
ariaColIndex: string;
|
1238
|
-
ariaColIndexText: string;
|
1239
1248
|
ariaColSpan: string;
|
1240
1249
|
ariaCurrent: string;
|
1250
|
+
ariaDescription: string;
|
1241
1251
|
ariaDisabled: string;
|
1242
1252
|
ariaExpanded: string;
|
1243
1253
|
ariaHasPopup: string;
|
@@ -1259,7 +1269,6 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1259
1269
|
ariaRoleDescription: string;
|
1260
1270
|
ariaRowCount: string;
|
1261
1271
|
ariaRowIndex: string;
|
1262
|
-
ariaRowIndexText: string;
|
1263
1272
|
ariaRowSpan: string;
|
1264
1273
|
ariaSelected: string;
|
1265
1274
|
ariaSetSize: string;
|
@@ -1284,17 +1293,19 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1284
1293
|
readonly lastElementChild: Element;
|
1285
1294
|
append(...nodes: (string | Node)[]): void;
|
1286
1295
|
prepend(...nodes: (string | Node)[]): void;
|
1287
|
-
querySelector<
|
1288
|
-
querySelector<
|
1296
|
+
querySelector<K_9 extends keyof HTMLElementTagNameMap>(selectors: K_9): HTMLElementTagNameMap[K_9];
|
1297
|
+
querySelector<K_10 extends keyof SVGElementTagNameMap>(selectors: K_10): SVGElementTagNameMap[K_10];
|
1298
|
+
querySelector<K_11 extends keyof MathMLElementTagNameMap>(selectors: K_11): MathMLElementTagNameMap[K_11];
|
1299
|
+
querySelector<K_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_12): HTMLElementDeprecatedTagNameMap[K_12];
|
1289
1300
|
querySelector<E_1 extends Element = Element>(selectors: string): E_1;
|
1290
|
-
querySelectorAll<
|
1291
|
-
querySelectorAll<
|
1301
|
+
querySelectorAll<K_13 extends keyof HTMLElementTagNameMap>(selectors: K_13): NodeListOf<HTMLElementTagNameMap[K_13]>;
|
1302
|
+
querySelectorAll<K_14 extends keyof SVGElementTagNameMap>(selectors: K_14): NodeListOf<SVGElementTagNameMap[K_14]>;
|
1303
|
+
querySelectorAll<K_15 extends keyof MathMLElementTagNameMap>(selectors: K_15): NodeListOf<MathMLElementTagNameMap[K_15]>;
|
1304
|
+
querySelectorAll<K_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_16): NodeListOf<HTMLElementDeprecatedTagNameMap[K_16]>;
|
1292
1305
|
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
|
1293
1306
|
replaceChildren(...nodes: (string | Node)[]): void;
|
1294
1307
|
readonly assignedSlot: HTMLSlotElement;
|
1295
|
-
|
1296
|
-
oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
1297
|
-
onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
1308
|
+
readonly attributeStyleMap: StylePropertyMap;
|
1298
1309
|
readonly style: CSSStyleDeclaration;
|
1299
1310
|
contentEditable: string;
|
1300
1311
|
enterKeyHint: string;
|
@@ -1307,6 +1318,7 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1307
1318
|
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
1308
1319
|
onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
1309
1320
|
onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
|
1321
|
+
onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
|
1310
1322
|
onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
1311
1323
|
oncancel: (this: GlobalEventHandlers, ev: Event) => any;
|
1312
1324
|
oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -1315,7 +1327,9 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1315
1327
|
onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
1316
1328
|
onclose: (this: GlobalEventHandlers, ev: Event) => any;
|
1317
1329
|
oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
1330
|
+
oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
1318
1331
|
oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
|
1332
|
+
oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
1319
1333
|
ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
1320
1334
|
ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
1321
1335
|
ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
@@ -1348,6 +1362,7 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1348
1362
|
onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
1349
1363
|
onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
1350
1364
|
onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
1365
|
+
onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
1351
1366
|
onpause: (this: GlobalEventHandlers, ev: Event) => any;
|
1352
1367
|
onplay: (this: GlobalEventHandlers, ev: Event) => any;
|
1353
1368
|
onplaying: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -1364,6 +1379,7 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
|
|
1364
1379
|
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
1365
1380
|
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
1366
1381
|
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
1382
|
+
onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
|
1367
1383
|
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
1368
1384
|
onseeked: (this: GlobalEventHandlers, ev: Event) => any;
|
1369
1385
|
onseeking: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -4422,7 +4438,7 @@ export declare class SocketMock implements Socket {
|
|
4422
4438
|
isReconnecting: boolean;
|
4423
4439
|
host: string;
|
4424
4440
|
nextMessage: Message;
|
4425
|
-
socketMessagesSubject: SocketSubject<Message
|
4441
|
+
socketMessagesSubject: SocketSubject<Message>;
|
4426
4442
|
connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
|
4427
4443
|
disconnect(): void;
|
4428
4444
|
send<T>(message: Message<any>): Promise<Message | any>;
|
@@ -39,4 +39,5 @@ export interface Connect
|
|
39
39
|
| [snapshot(resourceName, params)](./foundation-comms.connect.snapshot.md) | Retrieves a snapshot of data for the specified resource. |
|
40
40
|
| [stream(resourceName, onMessage, onError, params)](./foundation-comms.connect.stream.md) | Starts listening for updates on the specified resource. |
|
41
41
|
| [streamState(resourceName, onMessage, onError, params, initialState)](./foundation-comms.connect.streamstate.md) | Starts listening for updates on the specified resource. |
|
42
|
+
| [streamWithoutAutoTeardown(resourceName, onMessage, onError, params)](./foundation-comms.connect.streamwithoutautoteardown.md) | **_(ALPHA)_** Starts listening for updates on the specified resource without auto-teardown. |
|
42
43
|
|
@@ -0,0 +1,37 @@
|
|
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) > [streamWithoutAutoTeardown](./foundation-comms.connect.streamwithoutautoteardown.md)
|
4
|
+
|
5
|
+
## Connect.streamWithoutAutoTeardown() method
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
> Warning: This API is now obsolete.
|
11
|
+
>
|
12
|
+
> - Use `stream` instead. Will be removed in v15.
|
13
|
+
>
|
14
|
+
|
15
|
+
Starts listening for updates on the specified resource without auto-teardown.
|
16
|
+
|
17
|
+
**Signature:**
|
18
|
+
|
19
|
+
```typescript
|
20
|
+
streamWithoutAutoTeardown(resourceName: string, onMessage: Function, onError: Function, params?: DataserverParams): SocketObservable<Message>;
|
21
|
+
```
|
22
|
+
|
23
|
+
## Parameters
|
24
|
+
|
25
|
+
| Parameter | Type | Description |
|
26
|
+
| --- | --- | --- |
|
27
|
+
| resourceName | string | The name of the resource to listen for updates on. |
|
28
|
+
| onMessage | Function | A callback function to handle received messages. |
|
29
|
+
| onError | Function | A callback function to handle errors. |
|
30
|
+
| params | [DataserverParams](./foundation-comms.dataserverparams.md) | _(Optional)_ Additional parameters to pass to the server. |
|
31
|
+
|
32
|
+
**Returns:**
|
33
|
+
|
34
|
+
[SocketObservable](./foundation-comms.socketobservable.md)<!-- --><[Message](./foundation-comms.message.md)<!-- -->>
|
35
|
+
|
36
|
+
An observable that emits messages received from the server.
|
37
|
+
|
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md)
|
4
4
|
|
5
|
-
## DatasourceEventHandler
|
5
|
+
## DatasourceEventHandler() function
|
6
6
|
|
7
7
|
Datasource event handler mixin for target classes that use or are interested in datasource status changes.
|
8
8
|
|
@@ -32,11 +32,15 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
32
32
|
readonly offsetTop: number;
|
33
33
|
readonly offsetWidth: number;
|
34
34
|
outerText: string;
|
35
|
+
popover: string;
|
35
36
|
spellcheck: boolean;
|
36
37
|
title: string;
|
37
38
|
translate: boolean;
|
38
39
|
attachInternals(): ElementInternals;
|
39
40
|
click(): void;
|
41
|
+
hidePopover(): void;
|
42
|
+
showPopover(): void;
|
43
|
+
togglePopover(force?: boolean): boolean;
|
40
44
|
addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
|
41
45
|
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
|
42
46
|
removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
|
@@ -65,9 +69,12 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
65
69
|
slot: string;
|
66
70
|
readonly tagName: string;
|
67
71
|
attachShadow(init: ShadowRootInit): ShadowRoot;
|
72
|
+
checkVisibility(options?: CheckVisibilityOptions): boolean;
|
68
73
|
closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
|
69
74
|
closest<K_3 extends keyof SVGElementTagNameMap>(selector: K_3): SVGElementTagNameMap[K_3];
|
75
|
+
closest<K_4 extends keyof MathMLElementTagNameMap>(selector: K_4): MathMLElementTagNameMap[K_4];
|
70
76
|
closest<E extends Element = Element>(selectors: string): E;
|
77
|
+
computedStyleMap(): StylePropertyMapReadOnly;
|
71
78
|
getAttribute(qualifiedName: string): string;
|
72
79
|
getAttributeNS(namespace: string, localName: string): string;
|
73
80
|
getAttributeNames(): string[];
|
@@ -76,11 +83,14 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
76
83
|
getBoundingClientRect(): DOMRect;
|
77
84
|
getClientRects(): DOMRectList;
|
78
85
|
getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
|
79
|
-
getElementsByTagName<
|
80
|
-
getElementsByTagName<
|
86
|
+
getElementsByTagName<K_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<HTMLElementTagNameMap[K_5]>;
|
87
|
+
getElementsByTagName<K_6 extends keyof SVGElementTagNameMap>(qualifiedName: K_6): HTMLCollectionOf<SVGElementTagNameMap[K_6]>;
|
88
|
+
getElementsByTagName<K_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K_7): HTMLCollectionOf<MathMLElementTagNameMap[K_7]>;
|
89
|
+
getElementsByTagName<K_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K_8]>;
|
81
90
|
getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
|
82
91
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
|
83
92
|
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>;
|
93
|
+
getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>;
|
84
94
|
getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
|
85
95
|
hasAttribute(qualifiedName: string): boolean;
|
86
96
|
hasAttributeNS(namespace: string, localName: string): boolean;
|
@@ -138,24 +148,24 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
138
148
|
normalize(): void;
|
139
149
|
removeChild<T_2 extends Node>(child: T_2): T_2;
|
140
150
|
replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
|
141
|
-
readonly
|
142
|
-
readonly
|
143
|
-
readonly
|
144
|
-
readonly
|
145
|
-
readonly
|
146
|
-
readonly
|
147
|
-
readonly
|
148
|
-
readonly
|
149
|
-
readonly
|
150
|
-
readonly
|
151
|
-
readonly
|
152
|
-
readonly
|
153
|
-
readonly
|
154
|
-
readonly
|
155
|
-
readonly
|
156
|
-
readonly
|
157
|
-
readonly
|
158
|
-
readonly
|
151
|
+
readonly ELEMENT_NODE: 1;
|
152
|
+
readonly ATTRIBUTE_NODE: 2;
|
153
|
+
readonly TEXT_NODE: 3;
|
154
|
+
readonly CDATA_SECTION_NODE: 4;
|
155
|
+
readonly ENTITY_REFERENCE_NODE: 5;
|
156
|
+
readonly ENTITY_NODE: 6;
|
157
|
+
readonly PROCESSING_INSTRUCTION_NODE: 7;
|
158
|
+
readonly COMMENT_NODE: 8;
|
159
|
+
readonly DOCUMENT_NODE: 9;
|
160
|
+
readonly DOCUMENT_TYPE_NODE: 10;
|
161
|
+
readonly DOCUMENT_FRAGMENT_NODE: 11;
|
162
|
+
readonly NOTATION_NODE: 12;
|
163
|
+
readonly DOCUMENT_POSITION_DISCONNECTED: 1;
|
164
|
+
readonly DOCUMENT_POSITION_PRECEDING: 2;
|
165
|
+
readonly DOCUMENT_POSITION_FOLLOWING: 4;
|
166
|
+
readonly DOCUMENT_POSITION_CONTAINS: 8;
|
167
|
+
readonly DOCUMENT_POSITION_CONTAINED_BY: 16;
|
168
|
+
readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
|
159
169
|
dispatchEvent(event: Event): boolean;
|
160
170
|
ariaAtomic: string;
|
161
171
|
ariaAutoComplete: string;
|
@@ -163,9 +173,9 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
163
173
|
ariaChecked: string;
|
164
174
|
ariaColCount: string;
|
165
175
|
ariaColIndex: string;
|
166
|
-
ariaColIndexText: string;
|
167
176
|
ariaColSpan: string;
|
168
177
|
ariaCurrent: string;
|
178
|
+
ariaDescription: string;
|
169
179
|
ariaDisabled: string;
|
170
180
|
ariaExpanded: string;
|
171
181
|
ariaHasPopup: string;
|
@@ -187,7 +197,6 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
187
197
|
ariaRoleDescription: string;
|
188
198
|
ariaRowCount: string;
|
189
199
|
ariaRowIndex: string;
|
190
|
-
ariaRowIndexText: string;
|
191
200
|
ariaRowSpan: string;
|
192
201
|
ariaSelected: string;
|
193
202
|
ariaSetSize: string;
|
@@ -212,17 +221,19 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
212
221
|
readonly lastElementChild: Element;
|
213
222
|
append(...nodes: (string | Node)[]): void;
|
214
223
|
prepend(...nodes: (string | Node)[]): void;
|
215
|
-
querySelector<
|
216
|
-
querySelector<
|
224
|
+
querySelector<K_9 extends keyof HTMLElementTagNameMap>(selectors: K_9): HTMLElementTagNameMap[K_9];
|
225
|
+
querySelector<K_10 extends keyof SVGElementTagNameMap>(selectors: K_10): SVGElementTagNameMap[K_10];
|
226
|
+
querySelector<K_11 extends keyof MathMLElementTagNameMap>(selectors: K_11): MathMLElementTagNameMap[K_11];
|
227
|
+
querySelector<K_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_12): HTMLElementDeprecatedTagNameMap[K_12];
|
217
228
|
querySelector<E_1 extends Element = Element>(selectors: string): E_1;
|
218
|
-
querySelectorAll<
|
219
|
-
querySelectorAll<
|
229
|
+
querySelectorAll<K_13 extends keyof HTMLElementTagNameMap>(selectors: K_13): NodeListOf<HTMLElementTagNameMap[K_13]>;
|
230
|
+
querySelectorAll<K_14 extends keyof SVGElementTagNameMap>(selectors: K_14): NodeListOf<SVGElementTagNameMap[K_14]>;
|
231
|
+
querySelectorAll<K_15 extends keyof MathMLElementTagNameMap>(selectors: K_15): NodeListOf<MathMLElementTagNameMap[K_15]>;
|
232
|
+
querySelectorAll<K_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K_16): NodeListOf<HTMLElementDeprecatedTagNameMap[K_16]>;
|
220
233
|
querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
|
221
234
|
replaceChildren(...nodes: (string | Node)[]): void;
|
222
235
|
readonly assignedSlot: HTMLSlotElement;
|
223
|
-
|
224
|
-
oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
225
|
-
onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
|
236
|
+
readonly attributeStyleMap: StylePropertyMap;
|
226
237
|
readonly style: CSSStyleDeclaration;
|
227
238
|
contentEditable: string;
|
228
239
|
enterKeyHint: string;
|
@@ -235,6 +246,7 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
235
246
|
onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
|
236
247
|
onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
237
248
|
onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
|
249
|
+
onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
|
238
250
|
onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
|
239
251
|
oncancel: (this: GlobalEventHandlers, ev: Event) => any;
|
240
252
|
oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -243,7 +255,9 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
243
255
|
onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
244
256
|
onclose: (this: GlobalEventHandlers, ev: Event) => any;
|
245
257
|
oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
258
|
+
oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
246
259
|
oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
|
260
|
+
oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
247
261
|
ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
248
262
|
ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
249
263
|
ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
|
@@ -276,6 +290,7 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
276
290
|
onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
277
291
|
onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
278
292
|
onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
|
293
|
+
onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
|
279
294
|
onpause: (this: GlobalEventHandlers, ev: Event) => any;
|
280
295
|
onplay: (this: GlobalEventHandlers, ev: Event) => any;
|
281
296
|
onplaying: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -292,6 +307,7 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
292
307
|
onreset: (this: GlobalEventHandlers, ev: Event) => any;
|
293
308
|
onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
|
294
309
|
onscroll: (this: GlobalEventHandlers, ev: Event) => any;
|
310
|
+
onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
|
295
311
|
onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
|
296
312
|
onseeked: (this: GlobalEventHandlers, ev: Event) => any;
|
297
313
|
onseeking: (this: GlobalEventHandlers, ev: Event) => any;
|
@@ -332,6 +348,16 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
|
|
332
348
|
}
|
333
349
|
```
|
334
350
|
|
351
|
+
## Parameters
|
352
|
+
|
353
|
+
| Parameter | Type | Description |
|
354
|
+
| --- | --- | --- |
|
355
|
+
| Target | new () => HTMLElement & FASTElement | The class to mix the event handler with. |
|
356
|
+
|
357
|
+
**Returns:**
|
358
|
+
|
359
|
+
{ new (): { datasourceStatus: [DatasourceStatus](./foundation-comms.datasourcestatus.md)<!-- -->; resourceName: string; onDatasourceStatusChanged: (event: [DatasourceStatusChangedEvent](./foundation-comms.datasourcestatuschangedevent.md)<!-- -->) => void; datasourceStatusChanged(prev: [DatasourceStatus](./foundation-comms.datasourcestatus.md)<!-- -->, next: [DatasourceStatus](./foundation-comms.datasourcestatus.md)<!-- -->): void; connectedCallback(): void; disconnectedCallback(): void; accessKey: string; readonly accessKeyLabel: string; autocapitalize: string; dir: string; draggable: boolean; hidden: boolean; inert: boolean; innerText: string; lang: string; readonly offsetHeight: number; readonly offsetLeft: number; readonly offsetParent: Element; readonly offsetTop: number; readonly offsetWidth: number; outerText: string; popover: string; spellcheck: boolean; title: string; translate: boolean; attachInternals(): ElementInternals; click(): void; hidePopover(): void; showPopover(): void; togglePopover(force?: boolean): boolean; addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\]) => any, options?: boolean \| AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| AddEventListenerOptions): void; removeEventListener<K\_1 extends keyof HTMLElementEventMap>(type: K\_1, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\_1\]) => any, options?: boolean \| EventListenerOptions): void; removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| EventListenerOptions): void; readonly attributes: NamedNodeMap; readonly classList: DOMTokenList; className: string; readonly clientHeight: number; readonly clientLeft: number; readonly clientTop: number; readonly clientWidth: number; id: string; readonly localName: string; readonly namespaceURI: string; onfullscreenchange: (this: Element, ev: Event) => any; onfullscreenerror: (this: Element, ev: Event) => any; outerHTML: string; readonly ownerDocument: Document; readonly part: DOMTokenList; readonly prefix: string; readonly scrollHeight: number; scrollLeft: number; scrollTop: number; readonly scrollWidth: number; readonly shadowRoot: ShadowRoot; slot: string; readonly tagName: string; attachShadow(init: ShadowRootInit): ShadowRoot; checkVisibility(options?: CheckVisibilityOptions): boolean; closest<K\_2 extends keyof HTMLElementTagNameMap>(selector: K\_2): HTMLElementTagNameMap\[K\_2\]; closest<K\_3 extends keyof SVGElementTagNameMap>(selector: K\_3): SVGElementTagNameMap\[K\_3\]; closest<K\_4 extends keyof MathMLElementTagNameMap>(selector: K\_4): MathMLElementTagNameMap\[K\_4\]; closest<E extends Element = Element>(selectors: string): E; computedStyleMap(): StylePropertyMapReadOnly; getAttribute(qualifiedName: string): string; getAttributeNS(namespace: string, localName: string): string; getAttributeNames(): string\[\]; getAttributeNode(qualifiedName: string): Attr; getAttributeNodeNS(namespace: string, localName: string): Attr; getBoundingClientRect(): DOMRect; getClientRects(): DOMRectList; getElementsByClassName(classNames: string): HTMLCollectionOf<Element>; getElementsByTagName<K\_5 extends keyof HTMLElementTagNameMap>(qualifiedName: K\_5): HTMLCollectionOf<HTMLElementTagNameMap\[K\_5\]>; getElementsByTagName<K\_6 extends keyof SVGElementTagNameMap>(qualifiedName: K\_6): HTMLCollectionOf<SVGElementTagNameMap\[K\_6\]>; getElementsByTagName<K\_7 extends keyof MathMLElementTagNameMap>(qualifiedName: K\_7): HTMLCollectionOf<MathMLElementTagNameMap\[K\_7\]>; getElementsByTagName<K\_8 extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K\_8): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap\[K\_8\]>; getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>; getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>; hasAttribute(qualifiedName: string): boolean; hasAttributeNS(namespace: string, localName: string): boolean; hasAttributes(): boolean; hasPointerCapture(pointerId: number): boolean; insertAdjacentElement(where: InsertPosition, element: Element): Element; insertAdjacentHTML(position: InsertPosition, text: string): void; insertAdjacentText(where: InsertPosition, data: string): void; matches(selectors: string): boolean; releasePointerCapture(pointerId: number): void; removeAttribute(qualifiedName: string): void; removeAttributeNS(namespace: string, localName: string): void; removeAttributeNode(attr: Attr): Attr; requestFullscreen(options?: FullscreenOptions): Promise<void>; requestPointerLock(): void; scroll(options?: ScrollToOptions): void; scroll(x: number, y: number): void; scrollBy(options?: ScrollToOptions): void; scrollBy(x: number, y: number): void; scrollIntoView(arg?: boolean \| ScrollIntoViewOptions): void; scrollTo(options?: ScrollToOptions): void; scrollTo(x: number, y: number): void; setAttribute(qualifiedName: string, value: string): void; setAttributeNS(namespace: string, qualifiedName: string, value: string): void; setAttributeNode(attr: Attr): Attr; setAttributeNodeNS(attr: Attr): Attr; setPointerCapture(pointerId: number): void; toggleAttribute(qualifiedName: string, force?: boolean): boolean; webkitMatchesSelector(selectors: string): boolean; readonly baseURI: string; readonly childNodes: NodeListOf<ChildNode>; readonly firstChild: ChildNode; readonly isConnected: boolean; readonly lastChild: ChildNode; readonly nextSibling: ChildNode; readonly nodeName: string; readonly nodeType: number; nodeValue: string; readonly parentElement: HTMLElement; readonly parentNode: ParentNode; readonly previousSibling: ChildNode; textContent: string; appendChild<T extends Node>(node: T): T; cloneNode(deep?: boolean): Node; compareDocumentPosition(other: Node): number; contains(other: Node): boolean; getRootNode(options?: GetRootNodeOptions): Node; hasChildNodes(): boolean; insertBefore<T\_1 extends Node>(node: T\_1, child: Node): T\_1; isDefaultNamespace(namespace: string): boolean; isEqualNode(otherNode: Node): boolean; isSameNode(otherNode: Node): boolean; lookupNamespaceURI(prefix: string): string; lookupPrefix(namespace: string): string; normalize(): void; removeChild<T\_2 extends Node>(child: T\_2): T\_2; replaceChild<T\_3 extends Node>(node: Node, child: T\_3): T\_3; readonly ELEMENT\_NODE: 1; readonly ATTRIBUTE\_NODE: 2; readonly TEXT\_NODE: 3; readonly CDATA\_SECTION\_NODE: 4; readonly ENTITY\_REFERENCE\_NODE: 5; readonly ENTITY\_NODE: 6; readonly PROCESSING\_INSTRUCTION\_NODE: 7; readonly COMMENT\_NODE: 8; readonly DOCUMENT\_NODE: 9; readonly DOCUMENT\_TYPE\_NODE: 10; readonly DOCUMENT\_FRAGMENT\_NODE: 11; readonly NOTATION\_NODE: 12; readonly DOCUMENT\_POSITION\_DISCONNECTED: 1; readonly DOCUMENT\_POSITION\_PRECEDING: 2; readonly DOCUMENT\_POSITION\_FOLLOWING: 4; readonly DOCUMENT\_POSITION\_CONTAINS: 8; readonly DOCUMENT\_POSITION\_CONTAINED\_BY: 16; readonly DOCUMENT\_POSITION\_IMPLEMENTATION\_SPECIFIC: 32; dispatchEvent(event: Event): boolean; ariaAtomic: string; ariaAutoComplete: string; ariaBusy: string; ariaChecked: string; ariaColCount: string; ariaColIndex: string; ariaColSpan: string; ariaCurrent: string; ariaDescription: string; ariaDisabled: string; ariaExpanded: string; ariaHasPopup: string; ariaHidden: string; ariaInvalid: string; ariaKeyShortcuts: string; ariaLabel: string; ariaLevel: string; ariaLive: string; ariaModal: string; ariaMultiLine: string; ariaMultiSelectable: string; ariaOrientation: string; ariaPlaceholder: string; ariaPosInSet: string; ariaPressed: string; ariaReadOnly: string; ariaRequired: string; ariaRoleDescription: string; ariaRowCount: string; ariaRowIndex: string; ariaRowSpan: string; ariaSelected: string; ariaSetSize: string; ariaSort: string; ariaValueMax: string; ariaValueMin: string; ariaValueNow: string; ariaValueText: string; role: string; animate(keyframes: Keyframe\[\] \| PropertyIndexedKeyframes, options?: number \| KeyframeAnimationOptions): Animation; getAnimations(options?: GetAnimationsOptions): Animation\[\]; after(...nodes: (string \| Node)\[\]): void; before(...nodes: (string \| Node)\[\]): void; remove(): void; replaceWith(...nodes: (string \| Node)\[\]): void; innerHTML: string; readonly nextElementSibling: Element; readonly previousElementSibling: Element; readonly childElementCount: number; readonly children: HTMLCollection; readonly firstElementChild: Element; readonly lastElementChild: Element; append(...nodes: (string \| Node)\[\]): void; prepend(...nodes: (string \| Node)\[\]): void; querySelector<K\_9 extends keyof HTMLElementTagNameMap>(selectors: K\_9): HTMLElementTagNameMap\[K\_9\]; querySelector<K\_10 extends keyof SVGElementTagNameMap>(selectors: K\_10): SVGElementTagNameMap\[K\_10\]; querySelector<K\_11 extends keyof MathMLElementTagNameMap>(selectors: K\_11): MathMLElementTagNameMap\[K\_11\]; querySelector<K\_12 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K\_12): HTMLElementDeprecatedTagNameMap\[K\_12\]; querySelector<E\_1 extends Element = Element>(selectors: string): E\_1; querySelectorAll<K\_13 extends keyof HTMLElementTagNameMap>(selectors: K\_13): NodeListOf<HTMLElementTagNameMap\[K\_13\]>; querySelectorAll<K\_14 extends keyof SVGElementTagNameMap>(selectors: K\_14): NodeListOf<SVGElementTagNameMap\[K\_14\]>; querySelectorAll<K\_15 extends keyof MathMLElementTagNameMap>(selectors: K\_15): NodeListOf<MathMLElementTagNameMap\[K\_15\]>; querySelectorAll<K\_16 extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K\_16): NodeListOf<HTMLElementDeprecatedTagNameMap\[K\_16\]>; querySelectorAll<E\_2 extends Element = Element>(selectors: string): NodeListOf<E\_2>; replaceChildren(...nodes: (string \| Node)\[\]): void; readonly assignedSlot: HTMLSlotElement; readonly attributeStyleMap: StylePropertyMap; readonly style: CSSStyleDeclaration; contentEditable: string; enterKeyHint: string; inputMode: string; readonly isContentEditable: boolean; onabort: (this: GlobalEventHandlers, ev: UIEvent) => any; onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any; onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any; onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any; onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any; oncancel: (this: GlobalEventHandlers, ev: Event) => any; oncanplay: (this: GlobalEventHandlers, ev: Event) => any; oncanplaythrough: (this: GlobalEventHandlers, ev: Event) => any; onchange: (this: GlobalEventHandlers, ev: Event) => any; onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; onclose: (this: GlobalEventHandlers, ev: Event) => any; oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any; oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; oncuechange: (this: GlobalEventHandlers, ev: Event) => any; oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any; ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragenter: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragleave: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragover: (this: GlobalEventHandlers, ev: DragEvent) => any; ondragstart: (this: GlobalEventHandlers, ev: DragEvent) => any; ondrop: (this: GlobalEventHandlers, ev: DragEvent) => any; ondurationchange: (this: GlobalEventHandlers, ev: Event) => any; onemptied: (this: GlobalEventHandlers, ev: Event) => any; onended: (this: GlobalEventHandlers, ev: Event) => any; onerror: OnErrorEventHandlerNonNull; onfocus: (this: GlobalEventHandlers, ev: FocusEvent) => any; onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) => any; ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any; oninput: (this: GlobalEventHandlers, ev: Event) => any; oninvalid: (this: GlobalEventHandlers, ev: Event) => any; onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) => any; onload: (this: GlobalEventHandlers, ev: Event) => any; onloadeddata: (this: GlobalEventHandlers, ev: Event) => any; onloadedmetadata: (this: GlobalEventHandlers, ev: Event) => any; onloadstart: (this: GlobalEventHandlers, ev: Event) => any; onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) => any; onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any; onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any; onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any; onpause: (this: GlobalEventHandlers, ev: Event) => any; onplay: (this: GlobalEventHandlers, ev: Event) => any; onplaying: (this: GlobalEventHandlers, ev: Event) => any; onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) => any; onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) => any; onprogress: (this: GlobalEventHandlers, ev: ProgressEvent<EventTarget>) => any; onratechange: (this: GlobalEventHandlers, ev: Event) => any; onreset: (this: GlobalEventHandlers, ev: Event) => any; onresize: (this: GlobalEventHandlers, ev: UIEvent) => any; onscroll: (this: GlobalEventHandlers, ev: Event) => any; onscrollend: (this: GlobalEventHandlers, ev: Event) => any; onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any; onseeked: (this: GlobalEventHandlers, ev: Event) => any; onseeking: (this: GlobalEventHandlers, ev: Event) => any; onselect: (this: GlobalEventHandlers, ev: Event) => any; onselectionchange: (this: GlobalEventHandlers, ev: Event) => any; onselectstart: (this: GlobalEventHandlers, ev: Event) => any; onslotchange: (this: GlobalEventHandlers, ev: Event) => any; onstalled: (this: GlobalEventHandlers, ev: Event) => any; onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) => any; onsuspend: (this: GlobalEventHandlers, ev: Event) => any; ontimeupdate: (this: GlobalEventHandlers, ev: Event) => any; ontoggle: (this: GlobalEventHandlers, ev: Event) => any; ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) => any; ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) => any; ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) => any; onvolumechange: (this: GlobalEventHandlers, ev: Event) => any; onwaiting: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) => any; onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) => any; onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) => any; onwheel: (this: GlobalEventHandlers, ev: WheelEvent) => any; autofocus: boolean; readonly dataset: DOMStringMap; nonce?: string; tabIndex: number; blur(): void; focus(options?: FocusOptions): void; readonly $fastController: import("@microsoft/fast-element").Controller; $emit(type: string, detail?: any, options?: Omit<CustomEventInit<any>, "detail">): boolean \| void; attributeChangedCallback(name: string, oldValue: string, newValue: string): void; }; }
|
360
|
+
|
335
361
|
## Remarks
|
336
362
|
|
337
363
|
Classes that use the mixin are not required to own the datasource itself, there may be several interested parties.
|
@@ -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) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [\_initialized](./foundation-comms.defaultentitydatasource._initialized.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.\_initialized property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
|
11
|
+
**Signature:**
|
12
|
+
|
13
|
+
```typescript
|
14
|
+
protected _initialized: boolean;
|
15
|
+
```
|
@@ -0,0 +1,19 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [cache](./foundation-comms.defaultentitydatasource.cache.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.cache property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
**Signature:**
|
11
|
+
|
12
|
+
```typescript
|
13
|
+
get cache(): TEntity[];
|
14
|
+
```
|
15
|
+
|
16
|
+
## Remarks
|
17
|
+
|
18
|
+
In-memory entity cache.
|
19
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [disconnect](./foundation-comms.defaultentitydatasource.disconnect.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.disconnect property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
**Signature:**
|
11
|
+
|
12
|
+
```typescript
|
13
|
+
disconnect: () => void;
|
14
|
+
```
|
15
|
+
|
16
|
+
## Remarks
|
17
|
+
|
18
|
+
Disconnect and reset cache.
|
19
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [entityCache](./foundation-comms.defaultentitydatasource.entitycache.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.entityCache property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
**Signature:**
|
11
|
+
|
12
|
+
```typescript
|
13
|
+
protected entityCache: TEntity[];
|
14
|
+
```
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [entityMap](./foundation-comms.defaultentitydatasource.entitymap.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.entityMap property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
**Signature:**
|
11
|
+
|
12
|
+
```typescript
|
13
|
+
protected entityMap: Map<string, TEntity>;
|
14
|
+
```
|
@@ -0,0 +1,19 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [initialize](./foundation-comms.defaultentitydatasource.initialize.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.initialize property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
**Signature:**
|
11
|
+
|
12
|
+
```typescript
|
13
|
+
initialize: (init: EntityDatasourceInit<TDTO, TEntity>) => Promise<boolean>;
|
14
|
+
```
|
15
|
+
|
16
|
+
## Remarks
|
17
|
+
|
18
|
+
Initialize datasource.
|
19
|
+
|
@@ -0,0 +1,16 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [initialized](./foundation-comms.defaultentitydatasource.initialized.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.initialized property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
**Signature:**
|
11
|
+
|
12
|
+
```typescript
|
13
|
+
get initialized(): boolean;
|
14
|
+
|
15
|
+
set initialized(value: boolean);
|
16
|
+
```
|
@@ -0,0 +1,19 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [isEmpty](./foundation-comms.defaultentitydatasource.isempty.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.isEmpty property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
**Signature:**
|
11
|
+
|
12
|
+
```typescript
|
13
|
+
get isEmpty(): boolean;
|
14
|
+
```
|
15
|
+
|
16
|
+
## Remarks
|
17
|
+
|
18
|
+
Cache is empty / awaiting first result.
|
19
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
2
|
+
|
3
|
+
[Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) > [mapper](./foundation-comms.defaultentitydatasource.mapper.md)
|
4
|
+
|
5
|
+
## DefaultEntityDatasource.mapper property
|
6
|
+
|
7
|
+
> 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.
|
8
|
+
>
|
9
|
+
|
10
|
+
**Signature:**
|
11
|
+
|
12
|
+
```typescript
|
13
|
+
protected mapper: DTOMapper<TDTO, TEntity>;
|
14
|
+
```
|