Skip to content

Commit 974e568

Browse files
authored
[Web PubSub] Update CI for web-pubsub-express, fixes for docs (Azure#15009)
1 parent b50a070 commit 974e568

File tree

8 files changed

+26
-8
lines changed

8 files changed

+26
-8
lines changed

sdk/web-pubsub/ci.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,5 @@ extends:
3030
Artifacts:
3131
- name: azure-web-pubsub
3232
safeName: webpubsub
33+
- name: azure-web-pubsub-express
34+
safeName: webpubsubexpress

sdk/web-pubsub/web-pubsub-express/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
"test": "npm run build:test && npm run unit-test && npm run integration-test",
3131
"unit-test:browser": "echo \"Browser is not supported.\" && exit 0",
3232
"unit-test:node": "mocha --reporter ../../../common/tools/mocha-multi-reporter.js dist-test/index.node.js",
33-
"unit-test": "npm run unit-test:node && npm run unit-test:browser"
33+
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
34+
"docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --stripInternal --mode file --out ./dist/docs ./src"
3435
},
3536
"files": [
3637
"dist/",
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3+
"extends": ["../../../tsdoc.json"]
4+
}

sdk/web-pubsub/web-pubsub/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@
3030
"test": "npm run build:test && npm run unit-test && npm run integration-test",
3131
"unit-test:browser": "echo \"Browser is not supported.\" && exit 0",
3232
"unit-test:node": "mocha --reporter ../../../common/tools/mocha-multi-reporter.js dist-test/index.node.js",
33-
"unit-test": "npm run unit-test:node && npm run unit-test:browser"
33+
"unit-test": "npm run unit-test:node && npm run unit-test:browser",
34+
"docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --stripInternal --mode file --out ./dist/docs ./src"
3435
},
3536
"files": [
3637
"dist/",

sdk/web-pubsub/web-pubsub/src/generated/azureWebPubSubServiceRestAPIContext.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ import { AzureWebPubSubServiceRestAPIOptionalParams } from "./models";
44
const packageName = "WebPubSub";
55
const packageVersion = "1.0.0";
66

7+
/**
8+
* @hidden
9+
*/
710
export class AzureWebPubSubServiceRestAPIContext extends coreHttp.ServiceClient {
811
$host: string;
912
apiVersion?: string;

sdk/web-pubsub/web-pubsub/src/groupClient.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,9 @@ export interface WebPubSubGroup {
152152
sendToAll(message: HttpRequestBody, options?: GroupSendToAllOptions): Promise<RestResponse>;
153153
}
154154

155+
/**
156+
* @hidden
157+
*/
155158
export class WebPubSubGroupImpl implements WebPubSubGroup {
156159
private client!: GeneratedClient;
157160

sdk/web-pubsub/web-pubsub/src/hubClient.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -194,13 +194,13 @@ export class WebPubSubServiceClient {
194194
public endpoint!: string;
195195

196196
/**
197-
* Creates an instance of a HubClient for sending messages and managing groups, connections, and users.
197+
* Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.
198198
*
199199
* Example usage:
200200
* ```ts
201-
* import { HubClient } from "@azure/web-pubsub-management";
201+
* import { WebPubSubServiceClient } from "@azure/web-pubsub";
202202
* const connectionString = process.env['WEB_PUBSUB_CONNECTION_STRING'];
203-
* const client = new HubClient(connectionString, 'chat');
203+
* const client = new WebPubSubServiceClient(connectionString, 'chat');
204204
* ```
205205
*
206206
* @param connectionString The connection string
@@ -210,14 +210,14 @@ export class WebPubSubServiceClient {
210210
constructor(connectionString: string, hubName: string, options?: HubAdminClientOptions);
211211

212212
/**
213-
* Creates an instance of a HubClient for sending messages and managing groups, connections, and users.
213+
* Creates an instance of a WebPubSubServiceClient for sending messages and managing groups, connections, and users.
214214
*
215215
* Example usage:
216216
* ```ts
217-
* import { HubClient, AzureKeyCredential } from "@azure/web-pubsub-management";
217+
* import { WebPubSubServiceClient, AzureKeyCredential } from "@azure/web-pubsub";
218218
* const cred = new AzureKeyCredential("<your web pubsub api key>");
219219
* const endpoint = "https://xxxx.webpubsubdev.azure.com"
220-
* const client = new HubClient(endpoint, cred, 'chat');
220+
* const client = new WebPubSubServiceClient(endpoint, cred, 'chat');
221221
* ```
222222
*
223223
* @param endpoint The endpoint to connect to
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
3+
"extends": ["../../../tsdoc.json"]
4+
}

0 commit comments

Comments
 (0)