@genesislcap/foundation-broadcast-channel 14.225.3 → 14.225.4-alpha-9342136.0

package/dist/dts/broadcast-channel/broadcast-channel.d.ts.map

@@ -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,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"}
+{"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"}

package/dist/dts/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.9"
+      "packageVersion": "7.48.0"
     }
   ]
 }

package/dist/foundation-broadcast-channel.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.34.9",
+    "toolVersion": "7.48.0",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -173,17 +173,13 @@
       "preserveMemberOrder": false,
       "members": [
         {
-          "kind": "Variable",
-          "canonicalReference": "@genesislcap/foundation-broadcast-channel!createTypedBroadcastChannel:var",
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-broadcast-channel!createTypedBroadcastChannel:function(1)",
           "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",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "createTypedBroadcastChannel: "
-            },
-            {
-              "kind": "Content",
-              "text": "<TEventDetailMap extends "
+              "text": "createTypedBroadcastChannel: <TEventDetailMap extends "
             },
             {
               "kind": "Reference",
@@ -192,7 +188,15 @@
             },
             {
               "kind": "Content",
-              "text": ">(name: string) => "
+              "text": ">(name: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
             },
             {
               "kind": "Reference",
@@ -205,13 +209,36 @@
             }
           ],
           "fileUrlPath": "src/broadcast-channel/broadcast-channel.ts",
-          "isReadonly": true,
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 7
+          },
           "releaseTag": "Public",
-          "name": "createTypedBroadcastChannel",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 6
-          }
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "name",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "TEventDetailMap",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "createTypedBroadcastChannel"
         },
         {
           "kind": "Class",
@@ -406,17 +433,13 @@
           }
         },
         {
-          "kind": "Variable",
-          "canonicalReference": "@genesislcap/foundation-broadcast-channel!registerTypedBroadcastChannel:var",
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/foundation-broadcast-channel!registerTypedBroadcastChannel:function(1)",
           "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",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "registerTypedBroadcastChannel: "
-            },
-            {
-              "kind": "Content",
-              "text": "<TEventDetailMap extends "
+              "text": "registerTypedBroadcastChannel: <TEventDetailMap extends "
             },
             {
               "kind": "Reference",
@@ -425,7 +448,19 @@
             },
             {
               "kind": "Content",
-              "text": ">(name: string) => import(\"@microsoft/fast-foundation\")."
+              "text": ">(name: "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            },
+            {
+              "kind": "Content",
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@microsoft/fast-foundation\")."
             },
             {
               "kind": "Reference",
@@ -447,13 +482,36 @@
             }
           ],
           "fileUrlPath": "src/broadcast-channel/broadcast-channel.ts",
-          "isReadonly": true,
+          "returnTypeTokenRange": {
+            "startIndex": 5,
+            "endIndex": 10
+          },
           "releaseTag": "Public",
-          "name": "registerTypedBroadcastChannel",
-          "variableTypeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 8
-          }
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "name",
+              "parameterTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "isOptional": false
+            }
+          ],
+          "typeParameters": [
+            {
+              "typeParameterName": "TEventDetailMap",
+              "constraintTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "defaultTypeTokenRange": {
+                "startIndex": 0,
+                "endIndex": 0
+              }
+            }
+          ],
+          "name": "registerTypedBroadcastChannel"
         },
         {
           "kind": "Interface",

package/docs/api/foundation-broadcast-channel.createtypedbroadcastchannel.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-broadcast-channel](./foundation-broadcast-channel.md) > [createTypedBroadcastChannel](./foundation-broadcast-channel.createtypedbroadcastchannel.md)
 
-## createTypedBroadcastChannel variable
+## createTypedBroadcastChannel() function
 
 Creates a strongly typed broadcast channel.
 
@@ -12,6 +12,18 @@ Creates a strongly typed broadcast channel.
 createTypedBroadcastChannel: <TEventDetailMap extends EventDetailMap>(name: string) => DefaultTypedBroadcastChannel<TEventDetailMap>
 ```
 
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string | The channel name. |
+
+**Returns:**
+
+[DefaultTypedBroadcastChannel](./foundation-broadcast-channel.defaulttypedbroadcastchannel.md)<!-- -->&lt;TEventDetailMap&gt;
+
+The created TypedBroadcastChannel.
+
 ## Remarks
 
 `registerTypedBroadcastChannel` may be preferred, as it will create and register the channel in the DI.

package/docs/api/foundation-broadcast-channel.md

@@ -10,6 +10,13 @@
 |  --- | --- |
 |  [DefaultTypedBroadcastChannel](./foundation-broadcast-channel.defaulttypedbroadcastchannel.md) | Default TypedBroadcastChannel implementation. |
 
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [createTypedBroadcastChannel(name)](./foundation-broadcast-channel.createtypedbroadcastchannel.md) | Creates a strongly typed broadcast channel. |
+|  [registerTypedBroadcastChannel(name)](./foundation-broadcast-channel.registertypedbroadcastchannel.md) | Creates a dependency injection key for the broadcast channel being registered which is lazily created when injected. |
+
 ## Interfaces
 
 |  Interface | Description |
@@ -20,9 +27,7 @@
 
 |  Variable | Description |
 |  --- | --- |
-|  [createTypedBroadcastChannel](./foundation-broadcast-channel.createtypedbroadcastchannel.md) | Creates a strongly typed broadcast channel. |
 |  [logger](./foundation-broadcast-channel.logger.md) |  |
-|  [registerTypedBroadcastChannel](./foundation-broadcast-channel.registertypedbroadcastchannel.md) | Creates a dependency injection key for the broadcast channel being registered which is lazily created when injected. |
 
 ## Type Aliases
 

package/docs/api/foundation-broadcast-channel.registertypedbroadcastchannel.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-broadcast-channel](./foundation-broadcast-channel.md) > [registerTypedBroadcastChannel](./foundation-broadcast-channel.registertypedbroadcastchannel.md)
 
-## registerTypedBroadcastChannel variable
+## registerTypedBroadcastChannel() function
 
 Creates a dependency injection key for the broadcast channel being registered which is lazily created when injected.
 
@@ -12,6 +12,18 @@ Creates a dependency injection key for the broadcast channel being registered wh
 registerTypedBroadcastChannel: <TEventDetailMap extends EventDetailMap>(name: string) => import("@microsoft/fast-foundation").InterfaceSymbol<TypedBroadcastChannel<TEventDetailMap>>
 ```
 
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | string | The channel name. |
+
+**Returns:**
+
+import("@microsoft/fast-foundation").InterfaceSymbol&lt;[TypedBroadcastChannel](./foundation-broadcast-channel.typedbroadcastchannel.md)<!-- -->&lt;TEventDetailMap&gt;&gt;
+
+The created key.
+
 ## Example
 
 In a package's config.ts

package/docs/api/foundation-broadcast-channel.typedbroadcastchannel.md

@@ -24,7 +24,7 @@ export type GenesisResourcesEvents = {
 ...
 protected channel: TypedBroadcastChannel<GenesisResourcesEvents>;
 ```
-See the [registerTypedBroadcastChannel](./foundation-broadcast-channel.registertypedbroadcastchannel.md) and [createTypedBroadcastChannel](./foundation-broadcast-channel.createtypedbroadcastchannel.md) APIs below.
+See the [registerTypedBroadcastChannel()](./foundation-broadcast-channel.registertypedbroadcastchannel.md) and [createTypedBroadcastChannel()](./foundation-broadcast-channel.createtypedbroadcastchannel.md) APIs below.
 
 ## Properties
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/foundation-broadcast-channel",
   "description": "Genesis Broadcast Channel",
-  "version": "14.225.3",
+  "version": "14.225.4-alpha-9342136.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -24,18 +24,18 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.225.3",
-    "@genesislcap/genx": "14.225.3",
-    "@genesislcap/rollup-builder": "14.225.3",
-    "@genesislcap/ts-builder": "14.225.3",
-    "@genesislcap/uvu-playwright-builder": "14.225.3",
-    "@genesislcap/vite-builder": "14.225.3",
-    "@genesislcap/webpack-builder": "14.225.3",
+    "@genesislcap/foundation-testing": "14.225.4-alpha-9342136.0",
+    "@genesislcap/genx": "14.225.4-alpha-9342136.0",
+    "@genesislcap/rollup-builder": "14.225.4-alpha-9342136.0",
+    "@genesislcap/ts-builder": "14.225.4-alpha-9342136.0",
+    "@genesislcap/uvu-playwright-builder": "14.225.4-alpha-9342136.0",
+    "@genesislcap/vite-builder": "14.225.4-alpha-9342136.0",
+    "@genesislcap/webpack-builder": "14.225.4-alpha-9342136.0",
     "rimraf": "^5.0.0"
   },
   "dependencies": {
-    "@genesislcap/foundation-events": "14.225.3",
-    "@genesislcap/foundation-logger": "14.225.3",
+    "@genesislcap/foundation-events": "14.225.4-alpha-9342136.0",
+    "@genesislcap/foundation-logger": "14.225.4-alpha-9342136.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.49.6"
   },
@@ -47,5 +47,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8c9e4ede68df7e397194a05207ea7cd7b7a9f239"
+  "gitHead": "fc6d550b6235df216dc52fc120675e1a0cde3d1e"
 }