From 99e79a0bb30c227d5241f8783fb6269f010fa1d3 Mon Sep 17 00:00:00 2001
From: Brennan <brecon@microsoft.com>
Date: Tue, 22 Oct 2019 10:29:42 -0700
Subject: [PATCH] Mark classes in typescript as private for docs (#15265)
---
.github/CODEOWNERS | 2 +-
.../ts/signalr-protocol-msgpack/src/BinaryMessageFormat.ts | 1 +
src/SignalR/clients/ts/signalr/src/EmptyNodeHttpClient.ts | 1 +
src/SignalR/clients/ts/signalr/src/HttpConnection.ts | 1 +
src/SignalR/clients/ts/signalr/src/NodeHttpClient.ts | 1 +
src/SignalR/clients/ts/signalr/src/Polyfills.ts | 2 ++
6 files changed, 7 insertions(+), 1 deletion(-)
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 86a87beb593..103c64248fc 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -19,4 +19,4 @@
/src/Servers/ @tratcher @jkotalik @anurse @halter73
/src/Middleware/Rewrite @jkotalik @anurse
/src/Middleware/HttpsPolicy @jkotalik @anurse
-/src/SignalR/ @mikaelm12 @BrennanConroy @halter73 @anurse
+/src/SignalR/ @BrennanConroy @halter73 @anurse
diff --git a/src/SignalR/clients/ts/signalr-protocol-msgpack/src/BinaryMessageFormat.ts b/src/SignalR/clients/ts/signalr-protocol-msgpack/src/BinaryMessageFormat.ts
index 3de3bb0c37f..c597389236d 100644
--- a/src/SignalR/clients/ts/signalr-protocol-msgpack/src/BinaryMessageFormat.ts
+++ b/src/SignalR/clients/ts/signalr-protocol-msgpack/src/BinaryMessageFormat.ts
@@ -2,6 +2,7 @@
// Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
// Not exported from index.
+/** @private */
export class BinaryMessageFormat {
// The length prefix of binary messages is encoded as VarInt. Read the comment in
diff --git a/src/SignalR/clients/ts/signalr/src/EmptyNodeHttpClient.ts b/src/SignalR/clients/ts/signalr/src/EmptyNodeHttpClient.ts
index c756727cb0e..662bae5406e 100644
--- a/src/SignalR/clients/ts/signalr/src/EmptyNodeHttpClient.ts
+++ b/src/SignalR/clients/ts/signalr/src/EmptyNodeHttpClient.ts
@@ -6,6 +6,7 @@
import { HttpClient, HttpResponse } from "./HttpClient";
import { ILogger } from "./ILogger";
+/** @private */
export class NodeHttpClient extends HttpClient {
// @ts-ignore: Need ILogger to compile, but unused variables generate errors
public constructor(logger: ILogger) {
diff --git a/src/SignalR/clients/ts/signalr/src/HttpConnection.ts b/src/SignalR/clients/ts/signalr/src/HttpConnection.ts
index 5b1a3744cd3..075860006f1 100644
--- a/src/SignalR/clients/ts/signalr/src/HttpConnection.ts
+++ b/src/SignalR/clients/ts/signalr/src/HttpConnection.ts
@@ -547,6 +547,7 @@ function transportMatches(requestedTransport: HttpTransportType | undefined, act
return !requestedTransport || ((actualTransport & requestedTransport) !== 0);
}
+/** @private */
export class TransportSendQueue {
private buffer: any[] = [];
private sendBufferedData: PromiseSource;
diff --git a/src/SignalR/clients/ts/signalr/src/NodeHttpClient.ts b/src/SignalR/clients/ts/signalr/src/NodeHttpClient.ts
index 45750d48169..c0435fd057e 100644
--- a/src/SignalR/clients/ts/signalr/src/NodeHttpClient.ts
+++ b/src/SignalR/clients/ts/signalr/src/NodeHttpClient.ts
@@ -17,6 +17,7 @@ if (typeof XMLHttpRequest === "undefined") {
requestModule = requireFunc("request");
}
+/** @private */
export class NodeHttpClient extends HttpClient {
private readonly logger: ILogger;
private readonly request: typeof requestModule;
diff --git a/src/SignalR/clients/ts/signalr/src/Polyfills.ts b/src/SignalR/clients/ts/signalr/src/Polyfills.ts
index da388613033..468e4e7fa11 100644
--- a/src/SignalR/clients/ts/signalr/src/Polyfills.ts
+++ b/src/SignalR/clients/ts/signalr/src/Polyfills.ts
@@ -3,8 +3,10 @@
// Not exported from index
+/** @private */
export type EventSourceConstructor = new(url: string, eventSourceInitDict?: EventSourceInit) => EventSource;
+/** @private */
export interface WebSocketConstructor {
new(url: string, protocols?: string | string[], options?: any): WebSocket;
readonly CLOSED: number;
--
GitLab