@genesislcap/foundation-comms 14.225.4-alpha-5f6eefd.0 → 14.226.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (84) hide show
  1. package/dist/dts/datasource/datasource.mixins.d.ts +29 -45
  2. package/dist/dts/datasource/datasource.mixins.d.ts.map +1 -1
  3. package/dist/dts/testing/mocks/auth/auth.d.ts +1 -1
  4. package/dist/dts/testing/mocks/auth/auth.d.ts.map +1 -1
  5. package/dist/dts/testing/mocks/connect/socket.d.ts +1 -1
  6. package/dist/dts/testing/mocks/connect/socket.d.ts.map +1 -1
  7. package/dist/dts/tsdoc-metadata.json +1 -1
  8. package/dist/esm/auth/auth.js +2 -2
  9. package/dist/esm/connect/connect.js +8 -8
  10. package/dist/esm/connect/http.connect.js +7 -8
  11. package/dist/esm/connect/socket.js +5 -1
  12. package/dist/esm/credentialManager/credentialManager.js +2 -2
  13. package/dist/esm/datasource/datasource.js +7 -7
  14. package/dist/esm/networkMonitor/config.js +2 -1
  15. package/dist/esm/resources/genesis/genesis.js +1 -1
  16. package/dist/esm/storage/kv/kv.service.js +3 -3
  17. package/dist/foundation-comms.api.json +2413 -4907
  18. package/dist/foundation-comms.d.ts +31 -47
  19. package/docs/api/foundation-comms.connect.md +0 -1
  20. package/docs/api/foundation-comms.datasourceeventhandler.md +30 -56
  21. package/docs/api/foundation-comms.extractfielddefinitions.md +1 -14
  22. package/docs/api/foundation-comms.getkvstorage.md +1 -1
  23. package/docs/api/foundation-comms.md +6 -19
  24. package/docs/api/foundation-comms.messagehaserrorcode.md +1 -13
  25. package/docs/api/foundation-comms.messageorthrow.md +1 -14
  26. package/docs/api/foundation-comms.retryinterval.md +1 -15
  27. package/docs/api/foundation-comms.socket.md +0 -1
  28. package/docs/api/foundation-comms.tofieldmetadata.md +1 -14
  29. package/docs/{api-report.md.api.md → api-report.md} +31 -47
  30. package/package.json +14 -14
  31. package/docs/api/foundation-comms.connect.streamwithoutautoteardown.md +0 -37
  32. package/docs/api/foundation-comms.defaultentitydatasource._initialized.md +0 -15
  33. package/docs/api/foundation-comms.defaultentitydatasource.cache.md +0 -19
  34. package/docs/api/foundation-comms.defaultentitydatasource.disconnect.md +0 -19
  35. package/docs/api/foundation-comms.defaultentitydatasource.entitycache.md +0 -14
  36. package/docs/api/foundation-comms.defaultentitydatasource.entitymap.md +0 -14
  37. package/docs/api/foundation-comms.defaultentitydatasource.initialize.md +0 -19
  38. package/docs/api/foundation-comms.defaultentitydatasource.initialized.md +0 -16
  39. package/docs/api/foundation-comms.defaultentitydatasource.isempty.md +0 -19
  40. package/docs/api/foundation-comms.defaultentitydatasource.mapper.md +0 -14
  41. package/docs/api/foundation-comms.defaultentitydatasource.md +0 -38
  42. package/docs/api/foundation-comms.defaultentitydatasource.rowid.md +0 -14
  43. package/docs/api/foundation-comms.defaultentitydatasource.sourceref.md +0 -14
  44. package/docs/api/foundation-comms.defaultentitydatasource.subscription.md +0 -14
  45. package/docs/api/foundation-comms.defaultentitydatasource.subscriptionloggedoff.md +0 -14
  46. package/docs/api/foundation-comms.defaultkvstorage._constructor_.md +0 -25
  47. package/docs/api/foundation-comms.defaultkvstorage.md +0 -30
  48. package/docs/api/foundation-comms.defaultkvstorage.user.md +0 -14
  49. package/docs/api/foundation-comms.defaultkvstorageconfig.md +0 -16
  50. package/docs/api/foundation-comms.entitydatasource.cache.md +0 -19
  51. package/docs/api/foundation-comms.entitydatasource.disconnect.md +0 -22
  52. package/docs/api/foundation-comms.entitydatasource.initialize.md +0 -29
  53. package/docs/api/foundation-comms.entitydatasource.isempty.md +0 -19
  54. package/docs/api/foundation-comms.entitydatasource.md +0 -81
  55. package/docs/api/foundation-comms.entitydatasourceinit.fetchmeta.md +0 -14
  56. package/docs/api/foundation-comms.entitydatasourceinit.mapper.md +0 -14
  57. package/docs/api/foundation-comms.entitydatasourceinit.md +0 -25
  58. package/docs/api/foundation-comms.entitydatasourceinit.options.md +0 -14
  59. package/docs/api/foundation-comms.keyvalue.base64.md +0 -16
  60. package/docs/api/foundation-comms.keyvalue.expiration.md +0 -16
  61. package/docs/api/foundation-comms.keyvalue.key.md +0 -16
  62. package/docs/api/foundation-comms.keyvalue.md +0 -27
  63. package/docs/api/foundation-comms.keyvalue.metadata.md +0 -18
  64. package/docs/api/foundation-comms.keyvalue.value.md +0 -16
  65. package/docs/api/foundation-comms.keyvaluetransfer.deserialize.md +0 -25
  66. package/docs/api/foundation-comms.keyvaluetransfer.kv.md +0 -14
  67. package/docs/api/foundation-comms.keyvaluetransfer.md +0 -30
  68. package/docs/api/foundation-comms.keyvaluetransfer.serialize.md +0 -25
  69. package/docs/api/foundation-comms.kveventfailureresponse.md +0 -21
  70. package/docs/api/foundation-comms.kveventmessagetype.md +0 -24
  71. package/docs/api/foundation-comms.kvmessagetype.md +0 -24
  72. package/docs/api/foundation-comms.kvstorage.delete.md +0 -25
  73. package/docs/api/foundation-comms.kvstorage.get.md +0 -18
  74. package/docs/api/foundation-comms.kvstorage.get_1.md +0 -25
  75. package/docs/api/foundation-comms.kvstorage.list.md +0 -18
  76. package/docs/api/foundation-comms.kvstorage.md +0 -31
  77. package/docs/api/foundation-comms.kvstorage.put.md +0 -25
  78. package/docs/api/foundation-comms.kvstorageconfig.account.md +0 -16
  79. package/docs/api/foundation-comms.kvstorageconfig.authemail.md +0 -21
  80. package/docs/api/foundation-comms.kvstorageconfig.authkey.md +0 -16
  81. package/docs/api/foundation-comms.kvstorageconfig.md +0 -26
  82. package/docs/api/foundation-comms.kvstorageconfig.namespace.md +0 -16
  83. package/docs/api/foundation-comms.kvvalue.md +0 -16
  84. package/docs/api/foundation-comms.socket.sendforstreamwithoutteardown.md +0 -31
@@ -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/dist/esm';
19
19
  import { Subscription as SocketSubscription } from 'rxjs';
20
20
  import { Subject } from 'rxjs';
21
21
  import { TypedBroadcastChannel } from '@genesislcap/foundation-broadcast-channel';
@@ -1104,15 +1104,11 @@ 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;
1108
1107
  spellcheck: boolean;
1109
1108
  title: string;
1110
1109
  translate: boolean;
1111
1110
  attachInternals(): ElementInternals;
1112
1111
  click(): void;
1113
- hidePopover(): void;
1114
- showPopover(): void;
1115
- togglePopover(force?: boolean): boolean;
1116
1112
  addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
1117
1113
  addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
1118
1114
  removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
@@ -1141,12 +1137,9 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1141
1137
  slot: string;
1142
1138
  readonly tagName: string;
1143
1139
  attachShadow(init: ShadowRootInit): ShadowRoot;
1144
- checkVisibility(options?: CheckVisibilityOptions): boolean;
1145
1140
  closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
1146
1141
  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];
1148
1142
  closest<E extends Element = Element>(selectors: string): E;
1149
- computedStyleMap(): StylePropertyMapReadOnly;
1150
1143
  getAttribute(qualifiedName: string): string;
1151
1144
  getAttributeNS(namespace: string, localName: string): string;
1152
1145
  getAttributeNames(): string[];
@@ -1155,14 +1148,11 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1155
1148
  getBoundingClientRect(): DOMRect;
1156
1149
  getClientRects(): DOMRectList;
1157
1150
  getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
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]>;
1151
+ getElementsByTagName<K_4 extends keyof HTMLElementTagNameMap>(qualifiedName: K_4): HTMLCollectionOf<HTMLElementTagNameMap[K_4]>;
1152
+ getElementsByTagName<K_5 extends keyof SVGElementTagNameMap>(qualifiedName: K_5): HTMLCollectionOf<SVGElementTagNameMap[K_5]>;
1162
1153
  getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
1163
1154
  getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
1164
1155
  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>;
1166
1156
  getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
1167
1157
  hasAttribute(qualifiedName: string): boolean;
1168
1158
  hasAttributeNS(namespace: string, localName: string): boolean;
@@ -1220,24 +1210,24 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1220
1210
  normalize(): void;
1221
1211
  removeChild<T_2 extends Node>(child: T_2): T_2;
1222
1212
  replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
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;
1213
+ readonly ATTRIBUTE_NODE: number;
1214
+ readonly CDATA_SECTION_NODE: number;
1215
+ readonly COMMENT_NODE: number;
1216
+ readonly DOCUMENT_FRAGMENT_NODE: number;
1217
+ readonly DOCUMENT_NODE: number;
1218
+ readonly DOCUMENT_POSITION_CONTAINED_BY: number;
1219
+ readonly DOCUMENT_POSITION_CONTAINS: number;
1220
+ readonly DOCUMENT_POSITION_DISCONNECTED: number;
1221
+ readonly DOCUMENT_POSITION_FOLLOWING: number;
1222
+ readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: number;
1223
+ readonly DOCUMENT_POSITION_PRECEDING: number;
1224
+ readonly DOCUMENT_TYPE_NODE: number;
1225
+ readonly ELEMENT_NODE: number;
1226
+ readonly ENTITY_NODE: number;
1227
+ readonly ENTITY_REFERENCE_NODE: number;
1228
+ readonly NOTATION_NODE: number;
1229
+ readonly PROCESSING_INSTRUCTION_NODE: number;
1230
+ readonly TEXT_NODE: number;
1241
1231
  dispatchEvent(event: Event): boolean;
1242
1232
  ariaAtomic: string;
1243
1233
  ariaAutoComplete: string;
@@ -1245,9 +1235,9 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1245
1235
  ariaChecked: string;
1246
1236
  ariaColCount: string;
1247
1237
  ariaColIndex: string;
1238
+ ariaColIndexText: string;
1248
1239
  ariaColSpan: string;
1249
1240
  ariaCurrent: string;
1250
- ariaDescription: string;
1251
1241
  ariaDisabled: string;
1252
1242
  ariaExpanded: string;
1253
1243
  ariaHasPopup: string;
@@ -1269,6 +1259,7 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1269
1259
  ariaRoleDescription: string;
1270
1260
  ariaRowCount: string;
1271
1261
  ariaRowIndex: string;
1262
+ ariaRowIndexText: string;
1272
1263
  ariaRowSpan: string;
1273
1264
  ariaSelected: string;
1274
1265
  ariaSetSize: string;
@@ -1293,19 +1284,17 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1293
1284
  readonly lastElementChild: Element;
1294
1285
  append(...nodes: (string | Node)[]): void;
1295
1286
  prepend(...nodes: (string | Node)[]): void;
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];
1287
+ querySelector<K_6 extends keyof HTMLElementTagNameMap>(selectors: K_6): HTMLElementTagNameMap[K_6];
1288
+ querySelector<K_7 extends keyof SVGElementTagNameMap>(selectors: K_7): SVGElementTagNameMap[K_7];
1300
1289
  querySelector<E_1 extends Element = Element>(selectors: string): E_1;
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]>;
1290
+ querySelectorAll<K_8 extends keyof HTMLElementTagNameMap>(selectors: K_8): NodeListOf<HTMLElementTagNameMap[K_8]>;
1291
+ querySelectorAll<K_9 extends keyof SVGElementTagNameMap>(selectors: K_9): NodeListOf<SVGElementTagNameMap[K_9]>;
1305
1292
  querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
1306
1293
  replaceChildren(...nodes: (string | Node)[]): void;
1307
1294
  readonly assignedSlot: HTMLSlotElement;
1308
- readonly attributeStyleMap: StylePropertyMap;
1295
+ oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
1296
+ oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
1297
+ onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
1309
1298
  readonly style: CSSStyleDeclaration;
1310
1299
  contentEditable: string;
1311
1300
  enterKeyHint: string;
@@ -1318,7 +1307,6 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1318
1307
  onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
1319
1308
  onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1320
1309
  onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
1321
- onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
1322
1310
  onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
1323
1311
  oncancel: (this: GlobalEventHandlers, ev: Event) => any;
1324
1312
  oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
@@ -1327,9 +1315,7 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1327
1315
  onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1328
1316
  onclose: (this: GlobalEventHandlers, ev: Event) => any;
1329
1317
  oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1330
- oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
1331
1318
  oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
1332
- oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
1333
1319
  ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1334
1320
  ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
1335
1321
  ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
@@ -1362,7 +1348,6 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1362
1348
  onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1363
1349
  onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1364
1350
  onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
1365
- onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
1366
1351
  onpause: (this: GlobalEventHandlers, ev: Event) => any;
1367
1352
  onplay: (this: GlobalEventHandlers, ev: Event) => any;
1368
1353
  onplaying: (this: GlobalEventHandlers, ev: Event) => any;
@@ -1379,7 +1364,6 @@ export declare const DatasourceEventHandler: (Target: new () => HTMLElement & FA
1379
1364
  onreset: (this: GlobalEventHandlers, ev: Event) => any;
1380
1365
  onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
1381
1366
  onscroll: (this: GlobalEventHandlers, ev: Event) => any;
1382
- onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
1383
1367
  onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
1384
1368
  onseeked: (this: GlobalEventHandlers, ev: Event) => any;
1385
1369
  onseeking: (this: GlobalEventHandlers, ev: Event) => any;
@@ -4438,7 +4422,7 @@ export declare class SocketMock implements Socket {
4438
4422
  isReconnecting: boolean;
4439
4423
  host: string;
4440
4424
  nextMessage: Message;
4441
- socketMessagesSubject: SocketSubject<Message>;
4425
+ socketMessagesSubject: SocketSubject<Message<any>>;
4442
4426
  connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
4443
4427
  disconnect(): void;
4444
4428
  send<T>(message: Message<any>): Promise<Message | any>;
@@ -39,5 +39,4 @@ 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. |
43
42
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md)
4
4
 
5
- ## DatasourceEventHandler() function
5
+ ## DatasourceEventHandler variable
6
6
 
7
7
  Datasource event handler mixin for target classes that use or are interested in datasource status changes.
8
8
 
@@ -32,15 +32,11 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
32
32
  readonly offsetTop: number;
33
33
  readonly offsetWidth: number;
34
34
  outerText: string;
35
- popover: string;
36
35
  spellcheck: boolean;
37
36
  title: string;
38
37
  translate: boolean;
39
38
  attachInternals(): ElementInternals;
40
39
  click(): void;
41
- hidePopover(): void;
42
- showPopover(): void;
43
- togglePopover(force?: boolean): boolean;
44
40
  addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
45
41
  addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
46
42
  removeEventListener<K_1 extends keyof HTMLElementEventMap>(type: K_1, listener: (this: HTMLElement, ev: HTMLElementEventMap[K_1]) => any, options?: boolean | EventListenerOptions): void;
@@ -69,12 +65,9 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
69
65
  slot: string;
70
66
  readonly tagName: string;
71
67
  attachShadow(init: ShadowRootInit): ShadowRoot;
72
- checkVisibility(options?: CheckVisibilityOptions): boolean;
73
68
  closest<K_2 extends keyof HTMLElementTagNameMap>(selector: K_2): HTMLElementTagNameMap[K_2];
74
69
  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];
76
70
  closest<E extends Element = Element>(selectors: string): E;
77
- computedStyleMap(): StylePropertyMapReadOnly;
78
71
  getAttribute(qualifiedName: string): string;
79
72
  getAttributeNS(namespace: string, localName: string): string;
80
73
  getAttributeNames(): string[];
@@ -83,14 +76,11 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
83
76
  getBoundingClientRect(): DOMRect;
84
77
  getClientRects(): DOMRectList;
85
78
  getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
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]>;
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]>;
90
81
  getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
91
82
  getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>;
92
83
  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>;
94
84
  getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf<Element>;
95
85
  hasAttribute(qualifiedName: string): boolean;
96
86
  hasAttributeNS(namespace: string, localName: string): boolean;
@@ -148,24 +138,24 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
148
138
  normalize(): void;
149
139
  removeChild<T_2 extends Node>(child: T_2): T_2;
150
140
  replaceChild<T_3 extends Node>(node: Node, child: T_3): T_3;
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;
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;
169
159
  dispatchEvent(event: Event): boolean;
170
160
  ariaAtomic: string;
171
161
  ariaAutoComplete: string;
@@ -173,9 +163,9 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
173
163
  ariaChecked: string;
174
164
  ariaColCount: string;
175
165
  ariaColIndex: string;
166
+ ariaColIndexText: string;
176
167
  ariaColSpan: string;
177
168
  ariaCurrent: string;
178
- ariaDescription: string;
179
169
  ariaDisabled: string;
180
170
  ariaExpanded: string;
181
171
  ariaHasPopup: string;
@@ -197,6 +187,7 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
197
187
  ariaRoleDescription: string;
198
188
  ariaRowCount: string;
199
189
  ariaRowIndex: string;
190
+ ariaRowIndexText: string;
200
191
  ariaRowSpan: string;
201
192
  ariaSelected: string;
202
193
  ariaSetSize: string;
@@ -221,19 +212,17 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
221
212
  readonly lastElementChild: Element;
222
213
  append(...nodes: (string | Node)[]): void;
223
214
  prepend(...nodes: (string | Node)[]): void;
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];
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];
228
217
  querySelector<E_1 extends Element = Element>(selectors: string): E_1;
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]>;
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]>;
233
220
  querySelectorAll<E_2 extends Element = Element>(selectors: string): NodeListOf<E_2>;
234
221
  replaceChildren(...nodes: (string | Node)[]): void;
235
222
  readonly assignedSlot: HTMLSlotElement;
236
- readonly attributeStyleMap: StylePropertyMap;
223
+ oncopy: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
224
+ oncut: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
225
+ onpaste: (this: DocumentAndElementEventHandlers, ev: ClipboardEvent) => any;
237
226
  readonly style: CSSStyleDeclaration;
238
227
  contentEditable: string;
239
228
  enterKeyHint: string;
@@ -246,7 +235,6 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
246
235
  onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) => any;
247
236
  onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
248
237
  onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) => any;
249
- onbeforetoggle: (this: GlobalEventHandlers, ev: Event) => any;
250
238
  onblur: (this: GlobalEventHandlers, ev: FocusEvent) => any;
251
239
  oncancel: (this: GlobalEventHandlers, ev: Event) => any;
252
240
  oncanplay: (this: GlobalEventHandlers, ev: Event) => any;
@@ -255,9 +243,7 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
255
243
  onclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
256
244
  onclose: (this: GlobalEventHandlers, ev: Event) => any;
257
245
  oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) => any;
258
- oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
259
246
  oncuechange: (this: GlobalEventHandlers, ev: Event) => any;
260
- oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
261
247
  ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) => any;
262
248
  ondrag: (this: GlobalEventHandlers, ev: DragEvent) => any;
263
249
  ondragend: (this: GlobalEventHandlers, ev: DragEvent) => any;
@@ -290,7 +276,6 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
290
276
  onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) => any;
291
277
  onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) => any;
292
278
  onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) => any;
293
- onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) => any;
294
279
  onpause: (this: GlobalEventHandlers, ev: Event) => any;
295
280
  onplay: (this: GlobalEventHandlers, ev: Event) => any;
296
281
  onplaying: (this: GlobalEventHandlers, ev: Event) => any;
@@ -307,7 +292,6 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
307
292
  onreset: (this: GlobalEventHandlers, ev: Event) => any;
308
293
  onresize: (this: GlobalEventHandlers, ev: UIEvent) => any;
309
294
  onscroll: (this: GlobalEventHandlers, ev: Event) => any;
310
- onscrollend: (this: GlobalEventHandlers, ev: Event) => any;
311
295
  onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any;
312
296
  onseeked: (this: GlobalEventHandlers, ev: Event) => any;
313
297
  onseeking: (this: GlobalEventHandlers, ev: Event) => any;
@@ -348,16 +332,6 @@ DatasourceEventHandler: (Target: new () => HTMLElement & FASTElement) => {
348
332
  }
349
333
  ```
350
334
 
351
- ## Parameters
352
-
353
- | Parameter | Type | Description |
354
- | --- | --- | --- |
355
- | Target | new () =&gt; HTMLElement &amp; 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)<!-- -->) =&gt; 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&lt;K extends keyof HTMLElementEventMap&gt;(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\]) =&gt; any, options?: boolean \| AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean \| AddEventListenerOptions): void; removeEventListener&lt;K\_1 extends keyof HTMLElementEventMap&gt;(type: K\_1, listener: (this: HTMLElement, ev: HTMLElementEventMap\[K\_1\]) =&gt; 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) =&gt; any; onfullscreenerror: (this: Element, ev: Event) =&gt; 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&lt;K\_2 extends keyof HTMLElementTagNameMap&gt;(selector: K\_2): HTMLElementTagNameMap\[K\_2\]; closest&lt;K\_3 extends keyof SVGElementTagNameMap&gt;(selector: K\_3): SVGElementTagNameMap\[K\_3\]; closest&lt;K\_4 extends keyof MathMLElementTagNameMap&gt;(selector: K\_4): MathMLElementTagNameMap\[K\_4\]; closest&lt;E extends Element = Element&gt;(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&lt;Element&gt;; getElementsByTagName&lt;K\_5 extends keyof HTMLElementTagNameMap&gt;(qualifiedName: K\_5): HTMLCollectionOf&lt;HTMLElementTagNameMap\[K\_5\]&gt;; getElementsByTagName&lt;K\_6 extends keyof SVGElementTagNameMap&gt;(qualifiedName: K\_6): HTMLCollectionOf&lt;SVGElementTagNameMap\[K\_6\]&gt;; getElementsByTagName&lt;K\_7 extends keyof MathMLElementTagNameMap&gt;(qualifiedName: K\_7): HTMLCollectionOf&lt;MathMLElementTagNameMap\[K\_7\]&gt;; getElementsByTagName&lt;K\_8 extends keyof HTMLElementDeprecatedTagNameMap&gt;(qualifiedName: K\_8): HTMLCollectionOf&lt;HTMLElementDeprecatedTagNameMap\[K\_8\]&gt;; getElementsByTagName(qualifiedName: string): HTMLCollectionOf&lt;Element&gt;; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf&lt;HTMLElement&gt;; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf&lt;SVGElement&gt;; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf&lt;MathMLElement&gt;; getElementsByTagNameNS(namespace: string, localName: string): HTMLCollectionOf&lt;Element&gt;; 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&lt;void&gt;; 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&lt;ChildNode&gt;; 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&lt;T extends Node&gt;(node: T): T; cloneNode(deep?: boolean): Node; compareDocumentPosition(other: Node): number; contains(other: Node): boolean; getRootNode(options?: GetRootNodeOptions): Node; hasChildNodes(): boolean; insertBefore&lt;T\_1 extends Node&gt;(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&lt;T\_2 extends Node&gt;(child: T\_2): T\_2; replaceChild&lt;T\_3 extends Node&gt;(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&lt;K\_9 extends keyof HTMLElementTagNameMap&gt;(selectors: K\_9): HTMLElementTagNameMap\[K\_9\]; querySelector&lt;K\_10 extends keyof SVGElementTagNameMap&gt;(selectors: K\_10): SVGElementTagNameMap\[K\_10\]; querySelector&lt;K\_11 extends keyof MathMLElementTagNameMap&gt;(selectors: K\_11): MathMLElementTagNameMap\[K\_11\]; querySelector&lt;K\_12 extends keyof HTMLElementDeprecatedTagNameMap&gt;(selectors: K\_12): HTMLElementDeprecatedTagNameMap\[K\_12\]; querySelector&lt;E\_1 extends Element = Element&gt;(selectors: string): E\_1; querySelectorAll&lt;K\_13 extends keyof HTMLElementTagNameMap&gt;(selectors: K\_13): NodeListOf&lt;HTMLElementTagNameMap\[K\_13\]&gt;; querySelectorAll&lt;K\_14 extends keyof SVGElementTagNameMap&gt;(selectors: K\_14): NodeListOf&lt;SVGElementTagNameMap\[K\_14\]&gt;; querySelectorAll&lt;K\_15 extends keyof MathMLElementTagNameMap&gt;(selectors: K\_15): NodeListOf&lt;MathMLElementTagNameMap\[K\_15\]&gt;; querySelectorAll&lt;K\_16 extends keyof HTMLElementDeprecatedTagNameMap&gt;(selectors: K\_16): NodeListOf&lt;HTMLElementDeprecatedTagNameMap\[K\_16\]&gt;; querySelectorAll&lt;E\_2 extends Element = Element&gt;(selectors: string): NodeListOf&lt;E\_2&gt;; 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) =&gt; any; onanimationcancel: (this: GlobalEventHandlers, ev: AnimationEvent) =&gt; any; onanimationend: (this: GlobalEventHandlers, ev: AnimationEvent) =&gt; any; onanimationiteration: (this: GlobalEventHandlers, ev: AnimationEvent) =&gt; any; onanimationstart: (this: GlobalEventHandlers, ev: AnimationEvent) =&gt; any; onauxclick: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onbeforeinput: (this: GlobalEventHandlers, ev: InputEvent) =&gt; any; onbeforetoggle: (this: GlobalEventHandlers, ev: Event) =&gt; any; onblur: (this: GlobalEventHandlers, ev: FocusEvent) =&gt; any; oncancel: (this: GlobalEventHandlers, ev: Event) =&gt; any; oncanplay: (this: GlobalEventHandlers, ev: Event) =&gt; any; oncanplaythrough: (this: GlobalEventHandlers, ev: Event) =&gt; any; onchange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onclick: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onclose: (this: GlobalEventHandlers, ev: Event) =&gt; any; oncontextmenu: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; oncopy: (this: GlobalEventHandlers, ev: ClipboardEvent) =&gt; any; oncuechange: (this: GlobalEventHandlers, ev: Event) =&gt; any; oncut: (this: GlobalEventHandlers, ev: ClipboardEvent) =&gt; any; ondblclick: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; ondrag: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragend: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragenter: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragleave: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragover: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondragstart: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondrop: (this: GlobalEventHandlers, ev: DragEvent) =&gt; any; ondurationchange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onemptied: (this: GlobalEventHandlers, ev: Event) =&gt; any; onended: (this: GlobalEventHandlers, ev: Event) =&gt; any; onerror: OnErrorEventHandlerNonNull; onfocus: (this: GlobalEventHandlers, ev: FocusEvent) =&gt; any; onformdata: (this: GlobalEventHandlers, ev: FormDataEvent) =&gt; any; ongotpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; oninput: (this: GlobalEventHandlers, ev: Event) =&gt; any; oninvalid: (this: GlobalEventHandlers, ev: Event) =&gt; any; onkeydown: (this: GlobalEventHandlers, ev: KeyboardEvent) =&gt; any; onkeypress: (this: GlobalEventHandlers, ev: KeyboardEvent) =&gt; any; onkeyup: (this: GlobalEventHandlers, ev: KeyboardEvent) =&gt; any; onload: (this: GlobalEventHandlers, ev: Event) =&gt; any; onloadeddata: (this: GlobalEventHandlers, ev: Event) =&gt; any; onloadedmetadata: (this: GlobalEventHandlers, ev: Event) =&gt; any; onloadstart: (this: GlobalEventHandlers, ev: Event) =&gt; any; onlostpointercapture: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onmousedown: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseenter: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseleave: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmousemove: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseout: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseover: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onmouseup: (this: GlobalEventHandlers, ev: MouseEvent) =&gt; any; onpaste: (this: GlobalEventHandlers, ev: ClipboardEvent) =&gt; any; onpause: (this: GlobalEventHandlers, ev: Event) =&gt; any; onplay: (this: GlobalEventHandlers, ev: Event) =&gt; any; onplaying: (this: GlobalEventHandlers, ev: Event) =&gt; any; onpointercancel: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerdown: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerenter: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerleave: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointermove: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerout: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerover: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onpointerup: (this: GlobalEventHandlers, ev: PointerEvent) =&gt; any; onprogress: (this: GlobalEventHandlers, ev: ProgressEvent&lt;EventTarget&gt;) =&gt; any; onratechange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onreset: (this: GlobalEventHandlers, ev: Event) =&gt; any; onresize: (this: GlobalEventHandlers, ev: UIEvent) =&gt; any; onscroll: (this: GlobalEventHandlers, ev: Event) =&gt; any; onscrollend: (this: GlobalEventHandlers, ev: Event) =&gt; any; onsecuritypolicyviolation: (this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) =&gt; any; onseeked: (this: GlobalEventHandlers, ev: Event) =&gt; any; onseeking: (this: GlobalEventHandlers, ev: Event) =&gt; any; onselect: (this: GlobalEventHandlers, ev: Event) =&gt; any; onselectionchange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onselectstart: (this: GlobalEventHandlers, ev: Event) =&gt; any; onslotchange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onstalled: (this: GlobalEventHandlers, ev: Event) =&gt; any; onsubmit: (this: GlobalEventHandlers, ev: SubmitEvent) =&gt; any; onsuspend: (this: GlobalEventHandlers, ev: Event) =&gt; any; ontimeupdate: (this: GlobalEventHandlers, ev: Event) =&gt; any; ontoggle: (this: GlobalEventHandlers, ev: Event) =&gt; any; ontouchcancel?: (this: GlobalEventHandlers, ev: TouchEvent) =&gt; any; ontouchend?: (this: GlobalEventHandlers, ev: TouchEvent) =&gt; any; ontouchmove?: (this: GlobalEventHandlers, ev: TouchEvent) =&gt; any; ontouchstart?: (this: GlobalEventHandlers, ev: TouchEvent) =&gt; any; ontransitioncancel: (this: GlobalEventHandlers, ev: TransitionEvent) =&gt; any; ontransitionend: (this: GlobalEventHandlers, ev: TransitionEvent) =&gt; any; ontransitionrun: (this: GlobalEventHandlers, ev: TransitionEvent) =&gt; any; ontransitionstart: (this: GlobalEventHandlers, ev: TransitionEvent) =&gt; any; onvolumechange: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwaiting: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwebkitanimationend: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwebkitanimationiteration: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwebkitanimationstart: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwebkittransitionend: (this: GlobalEventHandlers, ev: Event) =&gt; any; onwheel: (this: GlobalEventHandlers, ev: WheelEvent) =&gt; 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&lt;CustomEventInit&lt;any&gt;, "detail"&gt;): boolean \| void; attributeChangedCallback(name: string, oldValue: string, newValue: string): void; }; }
360
-
361
335
  ## Remarks
362
336
 
363
337
  Classes that use the mixin are not required to own the datasource itself, there may be several interested parties.
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [extractFieldDefinitions](./foundation-comms.extractfielddefinitions.md)
4
4
 
5
- ## extractFieldDefinitions() function
5
+ ## extractFieldDefinitions variable
6
6
 
7
7
  Extracts the field definitions from the metadata.
8
8
 
@@ -11,16 +11,3 @@ Extracts the field definitions from the metadata.
11
11
  ```typescript
12
12
  extractFieldDefinitions: (metadata: Metadata) => MetadataDetail[]
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | metadata | [Metadata](./foundation-comms.metadata.md) | The metadata object. |
20
-
21
- **Returns:**
22
-
23
- [MetadataDetail](./foundation-comms.metadatadetail.md)<!-- -->\[\]
24
-
25
- An array of metadata detail.
26
-
@@ -13,7 +13,7 @@ export declare function getKVStorage(): KVStorage;
13
13
  ```
14
14
  **Returns:**
15
15
 
16
- [KVStorage](./foundation-comms.kvstorage.md)
16
+ KVStorage
17
17
 
18
18
  ## Remarks
19
19
 
@@ -16,12 +16,10 @@
16
16
  | [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) | Default ConnectEvents implementation. |
17
17
  | [DefaultCredentialManager](./foundation-comms.defaultcredentialmanager.md) | The default implementation for the CredentialManager interface. |
18
18
  | [DefaultDatasource](./foundation-comms.defaultdatasource.md) | The default implementation for the Datasource interface. |
19
- | [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) | **_(ALPHA)_** Default EntityDatasource DI implementation. |
20
19
  | [DefaultFoundationAnalytics](./foundation-comms.defaultfoundationanalytics.md) | The default implementation for the FoundationAnalytics interface. |
21
20
  | [DefaultGenesisResources](./foundation-comms.defaultgenesisresources.md) | Default GenesisResources implementation. |
22
21
  | [DefaultHttp](./foundation-comms.defaulthttp.md) | The default implementation of the Http interface. |
23
22
  | [DefaultHttpConnect](./foundation-comms.defaulthttpconnect.md) | The default implementation for the Connect interface (HTTP-only). |
24
- | [DefaultKVStorage](./foundation-comms.defaultkvstorage.md) | **_(ALPHA)_** The default implementation for the KVStorage interface. |
25
23
  | [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) | Default MessageBuilder implementation. |
26
24
  | [DefaultMetaCache](./foundation-comms.defaultmetacache.md) | The default implementation for the MetaCache interface. |
27
25
  | [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) | Default NetworkMonitor implementation. |
@@ -41,8 +39,6 @@
41
39
  | [EventMessageType](./foundation-comms.eventmessagetype.md) | Event Message types |
42
40
  | [FieldTypeEnum](./foundation-comms.fieldtypeenum.md) | Available types for a field metadata. |
43
41
  | [FoundationAnalyticsEventType](./foundation-comms.foundationanalyticseventtype.md) | Analytics event types |
44
- | [KVEventMessageType](./foundation-comms.kveventmessagetype.md) | **_(ALPHA)_** KV Event Message types |
45
- | [KVMessageType](./foundation-comms.kvmessagetype.md) | **_(ALPHA)_** KV Message types |
46
42
  | [MessageCode](./foundation-comms.messagecode.md) | General Message codes |
47
43
  | [MessageType](./foundation-comms.messagetype.md) | General Message types |
48
44
  | [ResourceType](./foundation-comms.resourcetype.md) | Types of Genesis resources. |
@@ -54,8 +50,6 @@
54
50
  | --- | --- |
55
51
  | [criteriaFiltersToFields(filters)](./foundation-comms.criteriafilterstofields.md) | Criteria filters to fields. |
56
52
  | [dataServerResultFilter(result, rowId)](./foundation-comms.dataserverresultfilter.md) | Data server result filter. |
57
- | [DatasourceEventHandler(Target)](./foundation-comms.datasourceeventhandler.md) | Datasource event handler mixin for target classes that use or are interested in datasource status changes. |
58
- | [extractFieldDefinitions(metadata)](./foundation-comms.extractfielddefinitions.md) | Extracts the field definitions from the metadata. |
59
53
  | [getConnect()](./foundation-comms.getconnect.md) | Get Connect from the DI container. |
60
54
  | [getDatasource()](./foundation-comms.getdatasource.md) | Get Datasource from the DI container. |
61
55
  | [getGenesisResources()](./foundation-comms.getgenesisresources.md) | Gets GenesisResources from the DI container. |
@@ -64,11 +58,7 @@
64
58
  | [getNetworkMonitor()](./foundation-comms.getnetworkmonitor.md) | Gets NetworkMonitor from the DI container. |
65
59
  | [getSocket()](./foundation-comms.getsocket.md) | Gets Socket from the DI container. |
66
60
  | [getSocketStatus()](./foundation-comms.getsocketstatus.md) | Gets SocketStatus from the DI container. |
67
- | [messageHasErrorCode(message, code)](./foundation-comms.messagehaserrorcode.md) | Check if the message contains an error code. |
68
- | [messageOrThrow(message)](./foundation-comms.messageorthrow.md) | Check if the provided message contains an error and throw an Error if it does |
69
61
  | [normaliseCriteria(criteria, delimiter)](./foundation-comms.normalisecriteria.md) | Normalise criteria. |
70
- | [retryInterval(reconnectOptions, scheduler)](./foundation-comms.retryinterval.md) | Generate reconnect interval based on scheduler |
71
- | [toFieldMetadata(fieldDef)](./foundation-comms.tofieldmetadata.md) | Converts the field definitions to field metadata. |
72
62
  | [until(conditionFunc, timeoutMs)](./foundation-comms.until.md) | Polls a condition function until it returns true or a timeout is reached. |
73
63
 
74
64
  ## Interfaces
@@ -89,8 +79,6 @@
89
79
  | [DatasourceOptions](./foundation-comms.datasourceoptions.md) | Options that can be passed when initializing a datasource. |
90
80
  | [DataUpdate](./foundation-comms.dataupdate.md) | Data Update definition with details of what data to add, drop, and/or modify. |
91
81
  | [Dataview](./foundation-comms.dataview.md) | Dataview object |
92
- | [EntityDatasource](./foundation-comms.entitydatasource.md) | **_(ALPHA)_** EntityDatasource DI interface. |
93
- | [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md) | **_(ALPHA)_** EntityDatasourceInit interface. |
94
82
  | [FoundationAnalytics](./foundation-comms.foundationanalytics.md) | Represents an analytics tracking system. |
95
83
  | [GenesisResources](./foundation-comms.genesisresources.md) | GenesisResources DI interface. |
96
84
  | [GenesisResourcesChannel](./foundation-comms.genesisresourceschannel.md) | GenesisResourcesChannel DI interface. |
@@ -98,10 +86,6 @@
98
86
  | [Http](./foundation-comms.http.md) | An interface representing an HTTP client that can make GET and POST requests and return a promise with the response data. |
99
87
  | [HttpRequestInit](./foundation-comms.httprequestinit.md) | The options object used when making an HTTP request. |
100
88
  | [JsonSchemaCache](./foundation-comms.jsonschemacache.md) | A JSON schema cache definition |
101
- | [KeyValue](./foundation-comms.keyvalue.md) | **_(ALPHA)_** KeyValue interface. |
102
- | [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md) | **_(ALPHA)_** KeyValueTransfer interface. |
103
- | [KVStorage](./foundation-comms.kvstorage.md) | **_(ALPHA)_** Represents a KV (key-value) data storage and its capabilities. Provides methods to set and get items from the KV data storage. |
104
- | [KVStorageConfig](./foundation-comms.kvstorageconfig.md) | **_(ALPHA)_** KVStorageConfig DI interface. |
105
89
  | [LogoutResult](./foundation-comms.logoutresult.md) | Represents the result of a user logout operation. |
106
90
  | [MessageBuilder](./foundation-comms.messagebuilder.md) | A utility class for building different types of messages. |
107
91
  | [MetadataCache](./foundation-comms.metadatacache.md) | A Metadata cache definition |
@@ -129,26 +113,31 @@
129
113
  | --- | --- |
130
114
  | [CommitEventType](./foundation-comms.commiteventtype.md) | |
131
115
  | [credentialSeparator](./foundation-comms.credentialseparator.md) | The default separator used for splitting credential parts. |
116
+ | [DatasourceEventHandler](./foundation-comms.datasourceeventhandler.md) | Datasource event handler mixin for target classes that use or are interested in datasource status changes. |
132
117
  | [DatasourceStatusChanged](./foundation-comms.datasourcestatuschanged.md) | DatasourceStatusChanged. |
133
118
  | [defaultConnectConfig](./foundation-comms.defaultconnectconfig.md) | The default configuration for connecting to a WS service. |
134
119
  | [defaultCredentialManagerConfig](./foundation-comms.defaultcredentialmanagerconfig.md) | The default configuration for the CredentialManager service. |
135
120
  | [defaultCredentialRequestOptions](./foundation-comms.defaultcredentialrequestoptions.md) | The default request options for the CredentialManager service. |
136
121
  | [defaultDatasourceConfig](./foundation-comms.defaultdatasourceconfig.md) | Default DatasourceConfig DI implementation. |
137
122
  | [defaultGenesisResourcesConfig](./foundation-comms.defaultgenesisresourcesconfig.md) | Default GenesisResourcesConfig implementation. |
138
- | [defaultKVStorageConfig](./foundation-comms.defaultkvstorageconfig.md) | **_(ALPHA)_** The default configuration for the KVStorage service. |
139
123
  | [defaultNetworkMonitorConfig](./foundation-comms.defaultnetworkmonitorconfig.md) | Default NetworkMonitorConfig DI implementation. |
140
124
  | [exponentialScheduler](./foundation-comms.exponentialscheduler.md) | Expontential Interval scheduler for reconnect |
125
+ | [extractFieldDefinitions](./foundation-comms.extractfielddefinitions.md) | Extracts the field definitions from the metadata. |
141
126
  | [GenesisResourcesChannelId](./foundation-comms.genesisresourceschannelid.md) | |
142
127
  | [isWebSocketExpression](./foundation-comms.iswebsocketexpression.md) | Regular Expression to test valid WebSocket (wss and ws) hosts |
143
128
  | [linearScheduler](./foundation-comms.linearscheduler.md) | Linear Interval scheduler for reconnect |
144
129
  | [logger](./foundation-comms.logger.md) | Logger for the foundation-comms package |
145
130
  | [MAX\_RECONNECT\_ATTEMPTS](./foundation-comms.max_reconnect_attempts.md) | Default number of reconnect attempts |
131
+ | [messageHasErrorCode](./foundation-comms.messagehaserrorcode.md) | Check if the message contains an error code. |
132
+ | [messageOrThrow](./foundation-comms.messageorthrow.md) | Check if the provided message contains an error and throw an Error if it does |
146
133
  | [MetadataEventType](./foundation-comms.metadataeventtype.md) | |
147
134
  | [networkLogger](./foundation-comms.networklogger.md) | |
135
+ | [retryInterval](./foundation-comms.retryinterval.md) | Generate reconnect interval based on scheduler |
148
136
  | [StreamCompleteEventType](./foundation-comms.streamcompleteeventtype.md) | |
149
137
  | [StreamErrorEventType](./foundation-comms.streamerroreventtype.md) | |
150
138
  | [StreamEventType](./foundation-comms.streameventtype.md) | |
151
139
  | [SystemHealthChanged](./foundation-comms.systemhealthchanged.md) | SystemHealthChanged. |
140
+ | [toFieldMetadata](./foundation-comms.tofieldmetadata.md) | Converts the field definitions to field metadata. |
152
141
  | [TYPES\_MAP](./foundation-comms.types_map.md) | Types map for FieldTypeEnum. |
153
142
 
154
143
  ## Type Aliases
@@ -173,8 +162,6 @@
173
162
  | [GetCredentialOptions](./foundation-comms.getcredentialoptions.md) | Represents options for retrieving credentials. |
174
163
  | [IndexDetail](./foundation-comms.indexdetail.md) | Index Detail definition. |
175
164
  | [JwtAuthInfo](./foundation-comms.jwtauthinfo.md) | Represents JWT authentication information. |
176
- | [KVEventFailureResponse](./foundation-comms.kveventfailureresponse.md) | **_(ALPHA)_** KVStorage type. |
177
- | [KVValue](./foundation-comms.kvvalue.md) | **_(ALPHA)_** KVValue type. |
178
165
  | [LoginResult](./foundation-comms.loginresult.md) | Represents the result of a user login operation. |
179
166
  | [Message](./foundation-comms.message.md) | Base Message type for all DETAIL variants |
180
167
  | [MessageError](./foundation-comms.messageerror.md) | Error definition for a message result |
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [messageHasErrorCode](./foundation-comms.messagehaserrorcode.md)
4
4
 
5
- ## messageHasErrorCode() function
5
+ ## messageHasErrorCode variable
6
6
 
7
7
  Check if the message contains an error code.
8
8
 
@@ -11,15 +11,3 @@ Check if the message contains an error code.
11
11
  ```typescript
12
12
  messageHasErrorCode: (message: Message, code: string | number) => boolean
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | message | [Message](./foundation-comms.message.md) | The message object. |
20
- | code | string \| number | The error code. Either a number or an entire status code string. |
21
-
22
- **Returns:**
23
-
24
- boolean
25
-
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [messageOrThrow](./foundation-comms.messageorthrow.md)
4
4
 
5
- ## messageOrThrow() function
5
+ ## messageOrThrow variable
6
6
 
7
7
  Check if the provided message contains an error and throw an Error if it does
8
8
 
@@ -11,16 +11,3 @@ Check if the provided message contains an error and throw an Error if it does
11
11
  ```typescript
12
12
  messageOrThrow: (message: Message) => Message<any>
13
13
  ```
14
-
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | message | [Message](./foundation-comms.message.md) | Message to check for errors |
20
-
21
- **Returns:**
22
-
23
- [Message](./foundation-comms.message.md)<!-- -->&lt;any&gt;
24
-
25
- The message if no errors are present, otherwise throws an Error
26
-