@genesislcap/foundation-broadcast-channel 14.226.0 → 14.226.2-alpha-bcda968.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (9) hide show
  1. package/dist/dts/broadcast-channel/broadcast-channel.d.ts.map +1 -1
  2. package/dist/dts/tsdoc-metadata.json +1 -1
  3. package/dist/foundation-broadcast-channel.api.json +29 -87
  4. package/docs/api/foundation-broadcast-channel.createtypedbroadcastchannel.md +1 -13
  5. package/docs/api/foundation-broadcast-channel.md +2 -7
  6. package/docs/api/foundation-broadcast-channel.registertypedbroadcastchannel.md +1 -13
  7. package/docs/api/foundation-broadcast-channel.typedbroadcastchannel.md +1 -1
  8. package/package.json +11 -11
  9. /package/docs/{api-report.md.api.md → api-report.md} +0 -0
package/dist/dts/broadcast-channel/broadcast-channel.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"broadcast-channel.d.ts","sourceRoot":"","sources":["../../../src/broadcast-channel/broadcast-channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAGhE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAC3B,eAAe,SAAS,cAAc,EACtC,CAAC,SAAS,MAAM,eAAe,IAC7B,YAAY,CAAC;IACf,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAC5B,CAAC,CAAC;AAEH;;GAEG;AACH,KAAK,WAAW,CAAC,eAAe,SAAS,cAAc,IAAI,CAAC,CAAC,SAAS,MAAM,eAAe,EACzF,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,KACzF,IAAI,CAAC;AAEV;;GAEG;AACH,KAAK,SAAS,CAAC,eAAe,SAAS,cAAc,IACjD,CAAC,CAAC,IAAI,EAAE,gBAAgB,EAAE,EAAE,EAAE,iBAAiB,CAAC,eAAe,EAAE,MAAM,eAAe,CAAC,KAAK,GAAG,CAAC,GAChG,IAAI,CAAC;AAET;;GAEG;AACH,KAAK,cAAc,CAAC,eAAe,SAAS,cAAc,IAAI,SAAS,CAAC,eAAe,CAAC,CAAC;AAEzF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,qBAAqB,CAAC,eAAe,SAAS,cAAc,CAC3E,SAAQ,IAAI,CAAC,gBAAgB,EAAE,aAAa,GAAG,WAAW,GAAG,gBAAgB,CAAC;IAC9E;;;;;;;;;;;;;;OAcG;IACH,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IAC1C;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IACtC,cAAc,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC;IAChD;;;;OAIG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,eAAe,EAC3C,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,iBAAiB,CAAC,eAAe,EAAE,MAAM,eAAe,CAAC,GAC/D,KAAK,IAAI,iBAAiB,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,qBAAa,4BAA4B,CAAC,eAAe,SAAS,cAAc,CAC9E,SAAQ,gBACR,YAAW,qBAAqB,CAAC,eAAe,CAAC;IAEjD,sDAAsD;IAEtD,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC,CAMvC;IACF,wDAAwD;IACxD,aAAa,0CACL,CAAC,SACA,kBAAkB,eAAe,EAAE,MAAM,eAAe,CAAC,oDAGhE;CACH;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,6BAA6B,iDAClC,MAAM,iGAQb,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,2BAA2B,iDAChC,MAAM,kDAGb,CAAC"}
1
+ {"version":3,"file":"broadcast-channel.d.ts","sourceRoot":"","sources":["../../../src/broadcast-channel/broadcast-channel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAGhE;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAC3B,eAAe,SAAS,cAAc,EACtC,CAAC,SAAS,MAAM,eAAe,IAC7B,YAAY,CAAC;IACf,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC;CAC5B,CAAC,CAAC;AAEH;;GAEG;AACH,KAAK,WAAW,CAAC,eAAe,SAAS,cAAc,IAAI,CAAC,CAAC,SAAS,MAAM,eAAe,EACzF,GAAG,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,SAAS,IAAI,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,CAAC,KACzF,IAAI,CAAC;AAEV;;GAEG;AACH,KAAK,SAAS,CAAC,eAAe,SAAS,cAAc,IACjD,CAAC,CAAC,IAAI,EAAE,gBAAgB,EAAE,EAAE,EAAE,iBAAiB,CAAC,eAAe,EAAE,MAAM,eAAe,CAAC,KAAK,GAAG,CAAC,GAChG,IAAI,CAAC;AAET;;GAEG;AACH,KAAK,cAAc,CAAC,eAAe,SAAS,cAAc,IAAI,SAAS,CAAC,eAAe,CAAC,CAAC;AAEzF;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,qBAAqB,CAAC,eAAe,SAAS,cAAc,CAC3E,SAAQ,IAAI,CAAC,gBAAgB,EAAE,aAAa,GAAG,WAAW,GAAG,gBAAgB,CAAC;IAC9E;;;;;;;;;;;;;;OAcG;IACH,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IAC1C;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,EAAE,SAAS,CAAC,eAAe,CAAC,CAAC;IACtC,cAAc,EAAE,cAAc,CAAC,eAAe,CAAC,CAAC;IAChD;;;;OAIG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,eAAe,EAC3C,IAAI,EAAE,CAAC,EACP,KAAK,EAAE,iBAAiB,CAAC,eAAe,EAAE,MAAM,eAAe,CAAC,GAC/D,KAAK,IAAI,iBAAiB,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,qBAAa,4BAA4B,CAAC,eAAe,SAAS,cAAc,CAC9E,SAAQ,gBACR,YAAW,qBAAqB,CAAC,eAAe,CAAC;IAEjD,sDAAsD;IAEtD,WAAW,EAAE,WAAW,CAAC,eAAe,CAAC,CAMvC;IACF,wDAAwD;IACxD,aAAa,oDAEJ,kBAAkB,eAAe,EAAE,MAAM,eAAe,CAAC,oDAGhE;CACH;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,6BAA6B,iDAClC,MAAM,iGAQb,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,2BAA2B,iDAChC,MAAM,kDAGb,CAAC"}
package/dist/dts/tsdoc-metadata.json CHANGED
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.48.0"
8
+ "packageVersion": "7.34.9"
9
9
  }
10
10
  ]
11
11
  }
package/dist/foundation-broadcast-channel.api.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.48.0",
4
+ "toolVersion": "7.34.9",
5
5
  "schemaVersion": 1011,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
@@ -173,30 +173,26 @@
173
173
  "preserveMemberOrder": false,
174
174
  "members": [
175
175
  {
176
- "kind": "Function",
177
- "canonicalReference": "@genesislcap/foundation-broadcast-channel!createTypedBroadcastChannel:function(1)",
176
+ "kind": "Variable",
177
+ "canonicalReference": "@genesislcap/foundation-broadcast-channel!createTypedBroadcastChannel:var",
178
178
  "docComment": "/**\n * Creates a strongly typed broadcast channel.\n *\n * @remarks\n *\n * `registerTypedBroadcastChannel` may be preferred, as it will create and register the channel in the DI.\n *\n * @param name - The channel name.\n *\n * @returns The created TypedBroadcastChannel.\n *\n * @example\n * ```ts\n * const channel = createTypedBroadcastChannel<GenesisResourcesEvents>(GenesisResourcesChannelId);\n * ```\n *\n * @public\n */\n",
179
179
  "excerptTokens": [
180
180
  {
181
181
  "kind": "Content",
182
- "text": "createTypedBroadcastChannel: <TEventDetailMap extends "
183
- },
184
- {
185
- "kind": "Reference",
186
- "text": "EventDetailMap",
187
- "canonicalReference": "@genesislcap/foundation-events!EventDetailMap:type"
182
+ "text": "createTypedBroadcastChannel: "
188
183
  },
189
184
  {
190
185
  "kind": "Content",
191
- "text": ">(name: "
186
+ "text": "<TEventDetailMap extends "
192
187
  },
193
188
  {
194
- "kind": "Content",
195
- "text": "string"
189
+ "kind": "Reference",
190
+ "text": "EventDetailMap",
191
+ "canonicalReference": "@genesislcap/foundation-events!EventDetailMap:type"
196
192
  },
197
193
  {
198
194
  "kind": "Content",
199
- "text": ") => "
195
+ "text": ">(name: string) => "
200
196
  },
201
197
  {
202
198
  "kind": "Reference",
@@ -209,36 +205,13 @@
209
205
  }
210
206
  ],
211
207
  "fileUrlPath": "src/broadcast-channel/broadcast-channel.ts",
212
- "returnTypeTokenRange": {
213
- "startIndex": 5,
214
- "endIndex": 7
215
- },
208
+ "isReadonly": true,
216
209
  "releaseTag": "Public",
217
- "overloadIndex": 1,
218
- "parameters": [
219
- {
220
- "parameterName": "name",
221
- "parameterTypeTokenRange": {
222
- "startIndex": 3,
223
- "endIndex": 4
224
- },
225
- "isOptional": false
226
- }
227
- ],
228
- "typeParameters": [
229
- {
230
- "typeParameterName": "TEventDetailMap",
231
- "constraintTokenRange": {
232
- "startIndex": 1,
233
- "endIndex": 2
234
- },
235
- "defaultTypeTokenRange": {
236
- "startIndex": 0,
237
- "endIndex": 0
238
- }
239
- }
240
- ],
241
- "name": "createTypedBroadcastChannel"
210
+ "name": "createTypedBroadcastChannel",
211
+ "variableTypeTokenRange": {
212
+ "startIndex": 1,
213
+ "endIndex": 6
214
+ }
242
215
  },
243
216
  {
244
217
  "kind": "Class",
@@ -433,34 +406,26 @@
433
406
  }
434
407
  },
435
408
  {
436
- "kind": "Function",
437
- "canonicalReference": "@genesislcap/foundation-broadcast-channel!registerTypedBroadcastChannel:function(1)",
409
+ "kind": "Variable",
410
+ "canonicalReference": "@genesislcap/foundation-broadcast-channel!registerTypedBroadcastChannel:var",
438
411
  "docComment": "/**\n * Creates a dependency injection key for the broadcast channel being registered which is lazily created when injected.\n *\n * @param name - The channel name.\n *\n * @returns The created key.\n *\n * @example\n *\n * In a package's config.ts\n * ```ts\n * export interface GenesisResourcesChannel extends TypedBroadcastChannel<GenesisResourcesEvents> {}\n * ...\n * export const GenesisResourcesChannel = registerTypedBroadcastChannel<GenesisResourcesEvents>(GenesisResourcesChannelId);\n * ```\n *\n * @public\n */\n",
439
412
  "excerptTokens": [
440
413
  {
441
414
  "kind": "Content",
442
- "text": "registerTypedBroadcastChannel: <TEventDetailMap extends "
443
- },
444
- {
445
- "kind": "Reference",
446
- "text": "EventDetailMap",
447
- "canonicalReference": "@genesislcap/foundation-events!EventDetailMap:type"
415
+ "text": "registerTypedBroadcastChannel: "
448
416
  },
449
417
  {
450
418
  "kind": "Content",
451
- "text": ">(name: "
419
+ "text": "<TEventDetailMap extends "
452
420
  },
453
421
  {
454
- "kind": "Content",
455
- "text": "string"
456
- },
457
- {
458
- "kind": "Content",
459
- "text": ") => "
422
+ "kind": "Reference",
423
+ "text": "EventDetailMap",
424
+ "canonicalReference": "@genesislcap/foundation-events!EventDetailMap:type"
460
425
  },
461
426
  {
462
427
  "kind": "Content",
463
- "text": "import(\"@microsoft/fast-foundation\")."
428
+ "text": ">(name: string) => import(\"@microsoft/fast-foundation\")."
464
429
  },
465
430
  {
466
431
  "kind": "Reference",
@@ -482,36 +447,13 @@
482
447
  }
483
448
  ],
484
449
  "fileUrlPath": "src/broadcast-channel/broadcast-channel.ts",
485
- "returnTypeTokenRange": {
486
- "startIndex": 5,
487
- "endIndex": 10
488
- },
450
+ "isReadonly": true,
489
451
  "releaseTag": "Public",
490
- "overloadIndex": 1,
491
- "parameters": [
492
- {
493
- "parameterName": "name",
494
- "parameterTypeTokenRange": {
495
- "startIndex": 3,
496
- "endIndex": 4
497
- },
498
- "isOptional": false
499
- }
500
- ],
501
- "typeParameters": [
502
- {
503
- "typeParameterName": "TEventDetailMap",
504
- "constraintTokenRange": {
505
- "startIndex": 1,
506
- "endIndex": 2
507
- },
508
- "defaultTypeTokenRange": {
509
- "startIndex": 0,
510
- "endIndex": 0
511
- }
512
- }
513
- ],
514
- "name": "registerTypedBroadcastChannel"
452
+ "name": "registerTypedBroadcastChannel",
453
+ "variableTypeTokenRange": {
454
+ "startIndex": 1,
455
+ "endIndex": 8
456
+ }
515
457
  },
516
458
  {
517
459
  "kind": "Interface",
package/docs/api/foundation-broadcast-channel.createtypedbroadcastchannel.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-broadcast-channel](./foundation-broadcast-channel.md) &gt; [createTypedBroadcastChannel](./foundation-broadcast-channel.createtypedbroadcastchannel.md)
4
4
 
5
- ## createTypedBroadcastChannel() function
5
+ ## createTypedBroadcastChannel variable
6
6
 
7
7
  Creates a strongly typed broadcast channel.
8
8
 
@@ -12,18 +12,6 @@ Creates a strongly typed broadcast channel.
12
12
  createTypedBroadcastChannel: <TEventDetailMap extends EventDetailMap>(name: string) => DefaultTypedBroadcastChannel<TEventDetailMap>
13
13
  ```
14
14
 
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | name | string | The channel name. |
20
-
21
- **Returns:**
22
-
23
- [DefaultTypedBroadcastChannel](./foundation-broadcast-channel.defaulttypedbroadcastchannel.md)<!-- -->&lt;TEventDetailMap&gt;
24
-
25
- The created TypedBroadcastChannel.
26
-
27
15
  ## Remarks
28
16
 
29
17
  `registerTypedBroadcastChannel` may be preferred, as it will create and register the channel in the DI.
package/docs/api/foundation-broadcast-channel.md CHANGED
@@ -10,13 +10,6 @@
10
10
  | --- | --- |
11
11
  | [DefaultTypedBroadcastChannel](./foundation-broadcast-channel.defaulttypedbroadcastchannel.md) | Default TypedBroadcastChannel implementation. |
12
12
 
13
- ## Functions
14
-
15
- | Function | Description |
16
- | --- | --- |
17
- | [createTypedBroadcastChannel(name)](./foundation-broadcast-channel.createtypedbroadcastchannel.md) | Creates a strongly typed broadcast channel. |
18
- | [registerTypedBroadcastChannel(name)](./foundation-broadcast-channel.registertypedbroadcastchannel.md) | Creates a dependency injection key for the broadcast channel being registered which is lazily created when injected. |
19
-
20
13
  ## Interfaces
21
14
 
22
15
  | Interface | Description |
@@ -27,7 +20,9 @@
27
20
 
28
21
  | Variable | Description |
29
22
  | --- | --- |
23
+ | [createTypedBroadcastChannel](./foundation-broadcast-channel.createtypedbroadcastchannel.md) | Creates a strongly typed broadcast channel. |
30
24
  | [logger](./foundation-broadcast-channel.logger.md) | |
25
+ | [registerTypedBroadcastChannel](./foundation-broadcast-channel.registertypedbroadcastchannel.md) | Creates a dependency injection key for the broadcast channel being registered which is lazily created when injected. |
31
26
 
32
27
  ## Type Aliases
33
28
 
package/docs/api/foundation-broadcast-channel.registertypedbroadcastchannel.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  [Home](./index.md) &gt; [@genesislcap/foundation-broadcast-channel](./foundation-broadcast-channel.md) &gt; [registerTypedBroadcastChannel](./foundation-broadcast-channel.registertypedbroadcastchannel.md)
4
4
 
5
- ## registerTypedBroadcastChannel() function
5
+ ## registerTypedBroadcastChannel variable
6
6
 
7
7
  Creates a dependency injection key for the broadcast channel being registered which is lazily created when injected.
8
8
 
@@ -12,18 +12,6 @@ Creates a dependency injection key for the broadcast channel being registered wh
12
12
  registerTypedBroadcastChannel: <TEventDetailMap extends EventDetailMap>(name: string) => import("@microsoft/fast-foundation").InterfaceSymbol<TypedBroadcastChannel<TEventDetailMap>>
13
13
  ```
14
14
 
15
- ## Parameters
16
-
17
- | Parameter | Type | Description |
18
- | --- | --- | --- |
19
- | name | string | The channel name. |
20
-
21
- **Returns:**
22
-
23
- import("@microsoft/fast-foundation").InterfaceSymbol&lt;[TypedBroadcastChannel](./foundation-broadcast-channel.typedbroadcastchannel.md)<!-- -->&lt;TEventDetailMap&gt;&gt;
24
-
25
- The created key.
26
-
27
15
  ## Example
28
16
 
29
17
  In a package's config.ts
package/docs/api/foundation-broadcast-channel.typedbroadcastchannel.md CHANGED
@@ -24,7 +24,7 @@ export type GenesisResourcesEvents = {
24
24
  ...
25
25
  protected channel: TypedBroadcastChannel<GenesisResourcesEvents>;
26
26
  ```
27
- See the [registerTypedBroadcastChannel()](./foundation-broadcast-channel.registertypedbroadcastchannel.md) and [createTypedBroadcastChannel()](./foundation-broadcast-channel.createtypedbroadcastchannel.md) APIs below.
27
+ See the [registerTypedBroadcastChannel](./foundation-broadcast-channel.registertypedbroadcastchannel.md) and [createTypedBroadcastChannel](./foundation-broadcast-channel.createtypedbroadcastchannel.md) APIs below.
28
28
 
29
29
  ## Properties
30
30
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genesislcap/foundation-broadcast-channel",
3
3
  "description": "Genesis Broadcast Channel",
4
- "version": "14.226.0",
4
+ "version": "14.226.2-alpha-bcda968.0",
5
5
  "sideEffects": false,
6
6
  "license": "SEE LICENSE IN license.txt",
7
7
  "main": "dist/esm/index.js",
@@ -24,18 +24,18 @@
24
24
  }
25
25
  },
26
26
  "devDependencies": {
27
- "@genesislcap/foundation-testing": "14.226.0",
28
- "@genesislcap/genx": "14.226.0",
29
- "@genesislcap/rollup-builder": "14.226.0",
30
- "@genesislcap/ts-builder": "14.226.0",
31
- "@genesislcap/uvu-playwright-builder": "14.226.0",
32
- "@genesislcap/vite-builder": "14.226.0",
33
- "@genesislcap/webpack-builder": "14.226.0",
27
+ "@genesislcap/foundation-testing": "14.226.2-alpha-bcda968.0",
28
+ "@genesislcap/genx": "14.226.2-alpha-bcda968.0",
29
+ "@genesislcap/rollup-builder": "14.226.2-alpha-bcda968.0",
30
+ "@genesislcap/ts-builder": "14.226.2-alpha-bcda968.0",
31
+ "@genesislcap/uvu-playwright-builder": "14.226.2-alpha-bcda968.0",
32
+ "@genesislcap/vite-builder": "14.226.2-alpha-bcda968.0",
33
+ "@genesislcap/webpack-builder": "14.226.2-alpha-bcda968.0",
34
34
  "rimraf": "^5.0.0"
35
35
  },
36
36
  "dependencies": {
37
- "@genesislcap/foundation-events": "14.226.0",
38
- "@genesislcap/foundation-logger": "14.226.0",
37
+ "@genesislcap/foundation-events": "14.226.2-alpha-bcda968.0",
38
+ "@genesislcap/foundation-logger": "14.226.2-alpha-bcda968.0",
39
39
  "@microsoft/fast-element": "1.14.0",
40
40
  "@microsoft/fast-foundation": "2.49.6"
41
41
  },
@@ -47,5 +47,5 @@
47
47
  "publishConfig": {
48
48
  "access": "public"
49
49
  },
50
- "gitHead": "92b4d205bf702945dbed4e9c998c4fd000d99e4b"
50
+ "gitHead": "9af9df8ba21d267f9bb916dcdc29796cd9f3e007"
51
51
  }
/package/docs/{api-report.md.api.md → api-report.md} RENAMED
File without changes