[Web PubSub] Update CI for web-pubsub-express, fixes for docs (Azure#…

…15009)
AzureSDKAutomation · Apr 24, 2021 · 974e568 · 974e568
1 parent b50a070
commit 974e568
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 8 deletions.
diff --git a/sdk/web-pubsub/ci.yml b/sdk/web-pubsub/ci.yml
@@ -30,3 +30,5 @@ extends:
     Artifacts:
       - name: azure-web-pubsub
         safeName: webpubsub
+      - name: azure-web-pubsub-express
+        safeName: webpubsubexpress
diff --git a/sdk/web-pubsub/web-pubsub-express/package.json b/sdk/web-pubsub/web-pubsub-express/package.json
@@ -30,7 +30,8 @@
     "test": "npm run build:test && npm run unit-test && npm run integration-test",
     "unit-test:browser": "echo \"Browser is not supported.\" && exit 0",
     "unit-test:node": "mocha --reporter ../../../common/tools/mocha-multi-reporter.js dist-test/index.node.js",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --stripInternal --mode file --out ./dist/docs ./src"
   },
   "files": [
     "dist/",

diff --git a/sdk/web-pubsub/web-pubsub-express/tsdoc.json b/sdk/web-pubsub/web-pubsub-express/tsdoc.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../../tsdoc.json"]
+}
diff --git a/sdk/web-pubsub/web-pubsub/package.json b/sdk/web-pubsub/web-pubsub/package.json
@@ -30,7 +30,8 @@
     "test": "npm run build:test && npm run unit-test && npm run integration-test",
     "unit-test:browser": "echo \"Browser is not supported.\" && exit 0",
     "unit-test:node": "mocha --reporter ../../../common/tools/mocha-multi-reporter.js dist-test/index.node.js",
-    "unit-test": "npm run unit-test:node && npm run unit-test:browser"
+    "unit-test": "npm run unit-test:node && npm run unit-test:browser",
+    "docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --stripInternal --mode file --out ./dist/docs ./src"
   },
   "files": [
     "dist/",

diff --git a/sdk/web-pubsub/web-pubsub/src/generated/azureWebPubSubServiceRestAPIContext.ts b/sdk/web-pubsub/web-pubsub/src/generated/azureWebPubSubServiceRestAPIContext.ts
@@ -4,6 +4,9 @@ import { AzureWebPubSubServiceRestAPIOptionalParams } from "./models";
 const packageName = "WebPubSub";
 const packageVersion = "1.0.0";
 
+/**
+ * @hidden
+ */
 export class AzureWebPubSubServiceRestAPIContext extends coreHttp.ServiceClient {
   $host: string;
   apiVersion?: string;

diff --git a/sdk/web-pubsub/web-pubsub/src/groupClient.ts b/sdk/web-pubsub/web-pubsub/src/groupClient.ts
@@ -152,6 +152,9 @@ export interface WebPubSubGroup {
   sendToAll(message: HttpRequestBody, options?: GroupSendToAllOptions): Promise<RestResponse>;
 }
 
+/**
+ * @hidden
+ */
 export class WebPubSubGroupImpl implements WebPubSubGroup {
   private client!: GeneratedClient;
 

diff --git a/sdk/web-pubsub/web-pubsub/src/hubClient.ts b/sdk/web-pubsub/web-pubsub/src/hubClient.ts
@@ -194,13 +194,13 @@ export class WebPubSubServiceClient {
   public endpoint!: string;
 
   /**
-   * Creates an instance of a HubClient for sending messages and managing groups, connections, and users.
+   * Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.
    *
    * Example usage:
    * ```ts
-   * import { HubClient } from "@azure/web-pubsub-management";
+   * import { WebPubSubServiceClient } from "@azure/web-pubsub";
    * const connectionString = process.env['WEB_PUBSUB_CONNECTION_STRING'];
-   * const client = new HubClient(connectionString, 'chat');
+   * const client = new WebPubSubServiceClient(connectionString, 'chat');
    * ```
    *
    * @param connectionString The connection string
@@ -210,14 +210,14 @@ export class WebPubSubServiceClient {
   constructor(connectionString: string, hubName: string, options?: HubAdminClientOptions);
 
   /**
-   * Creates an instance of a HubClient for sending messages and managing groups, connections, and users.
+   * Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.
    *
    * Example usage:
    * ```ts
-   * import { HubClient, AzureKeyCredential } from "@azure/web-pubsub-management";
+   * import { WebPubSubServiceClient, AzureKeyCredential } from "@azure/web-pubsub";
    * const cred = new AzureKeyCredential("<your web pubsub api key>");
    * const endpoint = "https://xxxx.webpubsubdev.azure.com"
-   * const client = new HubClient(endpoint, cred, 'chat');
+   * const client = new WebPubSubServiceClient(endpoint, cred, 'chat');
    * ```
    *
    * @param endpoint The endpoint to connect to

diff --git a/sdk/web-pubsub/web-pubsub/tsdoc.json b/sdk/web-pubsub/web-pubsub/tsdoc.json
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
+  "extends": ["../../../tsdoc.json"]
+}