diff --git a/sdk/appconfiguration/app-configuration/src/internal/helpers.ts b/sdk/appconfiguration/app-configuration/src/internal/helpers.ts index a56a0c61ecb8..e1f3717b2f08 100644 --- a/sdk/appconfiguration/app-configuration/src/internal/helpers.ts +++ b/sdk/appconfiguration/app-configuration/src/internal/helpers.ts @@ -161,8 +161,8 @@ export function makeConfigurationSettingEmpty( } /** - * @internal * @hidden + * @internal */ export function transformKeyValue(kvp: KeyValue): ConfigurationSetting { const obj: ConfigurationSetting & KeyValue = { @@ -175,8 +175,8 @@ export function transformKeyValue(kvp: KeyValue): ConfigurationSetting { } /** - * @internal * @hidden + * @internal */ export function transformKeyValueResponseWithStatusCode< T extends KeyValue & HttpResponseField @@ -190,8 +190,8 @@ export function transformKeyValueResponseWithStatusCode< } /** - * @internal * @hidden + * @internal */ export function transformKeyValueResponse< T extends KeyValue & { eTag?: string } & HttpResponseField diff --git a/sdk/appconfiguration/app-configuration/tsdoc.json b/sdk/appconfiguration/app-configuration/tsdoc.json index 1665e79638d8..b3b90814073d 100644 --- a/sdk/appconfiguration/app-configuration/tsdoc.json +++ b/sdk/appconfiguration/app-configuration/tsdoc.json @@ -3,4 +3,4 @@ "extends": [ "../../../tsdoc.json" ] -} \ No newline at end of file +} diff --git a/sdk/core/core-amqp/src/connectionConfig/connectionConfig.ts b/sdk/core/core-amqp/src/connectionConfig/connectionConfig.ts index 0456a6130c05..3dc8802a06ad 100644 --- a/sdk/core/core-amqp/src/connectionConfig/connectionConfig.ts +++ b/sdk/core/core-amqp/src/connectionConfig/connectionConfig.ts @@ -167,7 +167,7 @@ export const ConnectionConfig = { /** * @internal - * @ignore + * @hidden */ export function isSharedAccessSignature(connectionString: string): boolean { return connectionString.match(/;{0,1}SharedAccessSignature=SharedAccessSignature /) != null; diff --git a/sdk/core/core-amqp/src/errors.ts b/sdk/core/core-amqp/src/errors.ts index 96c074c1c3be..de28de8a2d5e 100644 --- a/sdk/core/core-amqp/src/errors.ts +++ b/sdk/core/core-amqp/src/errors.ts @@ -9,7 +9,7 @@ import { isNode, isNumber, isString } from "../src/util/utils"; * Maps the conditions to the numeric AMQP Response status codes. * @enum {ConditionStatusMapper} * @internal - * @ignore + * @hidden */ export enum ConditionStatusMapper { "com.microsoft:timeout" = AmqpResponseStatusCode.RequestTimeout, @@ -457,7 +457,7 @@ export interface NetworkSystemError { /** * @internal - * @ignore + * @hidden */ const systemErrorFieldsToCopy: (keyof Omit)[] = [ "address", @@ -608,7 +608,7 @@ export function isSystemError(err: any): err is NetworkSystemError { /** * @internal - * @ignore + * @hidden * Since browser doesn't differentiate between the various kinds of service communication errors, * this utility is used to look at the error target to identify such category of errors. * For more information refer to - https://html.spec.whatwg.org/multipage/comms.html#feedback-from-the-protocol @@ -629,7 +629,7 @@ function isBrowserWebsocketError(err: any): boolean { /** * @internal - * @ignore + * @hidden */ const rheaPromiseErrors = [ // OperationTimeoutError occurs when the service fails to respond within a given timeframe. @@ -729,7 +729,7 @@ export function translate(err: AmqpError | Error): MessagingError | Error { /** * @internal - * @ignore + * @hidden * * @param {*} error * @returns {error is AmqpError} diff --git a/sdk/core/core-amqp/src/log.ts b/sdk/core/core-amqp/src/log.ts index 05140e1c0cd7..d868350750ef 100644 --- a/sdk/core/core-amqp/src/log.ts +++ b/sdk/core/core-amqp/src/log.ts @@ -12,7 +12,7 @@ export const logger = createClientLogger("core-amqp"); /** * Logs the error's stack trace to "verbose" if a stack trace is available. * @param error Error containing a stack trace. - * @ignore + * @hidden */ export function logErrorStackTrace(error: any): void { if (error && error.stack) { diff --git a/sdk/core/core-amqp/src/requestResponseLink.ts b/sdk/core/core-amqp/src/requestResponseLink.ts index abf55274cfec..13dfc39f2a25 100644 --- a/sdk/core/core-amqp/src/requestResponseLink.ts +++ b/sdk/core/core-amqp/src/requestResponseLink.ts @@ -40,7 +40,7 @@ export interface SendRequestOptions { /** * @internal - * @ignore + * @hidden */ export interface DeferredPromiseWithCallback { resolve: (value?: any) => void; @@ -230,7 +230,7 @@ export class RequestResponseLink implements ReqResLink { } /** * @internal - * @ignore + * @hidden * * Type used in getCodeDescriptionAndError to get the normalized info from the responses emitted by EventHubs and ServiceBus. */ @@ -242,7 +242,7 @@ type NormalizedInfo = { /** * @internal - * @ignore + * @hidden * * Handle different variations of property names in responses emitted by EventHubs and ServiceBus. * @@ -271,7 +271,7 @@ export const getCodeDescriptionAndError = (props: any): NormalizedInfo => { * 5. User's code after the sendRequest continues. * * @internal - * @ignore + * @hidden */ export function onMessageReceived( context: Pick, diff --git a/sdk/core/core-amqp/src/retry.ts b/sdk/core/core-amqp/src/retry.ts index 20a814d49763..cbf8cfcddce2 100644 --- a/sdk/core/core-amqp/src/retry.ts +++ b/sdk/core/core-amqp/src/retry.ts @@ -11,7 +11,7 @@ import { checkNetworkConnection } from "./util/checkNetworkConnection"; /** * Determines whether the object is a Delivery object. - * @ignore + * @hidden */ function isDelivery(obj: any): boolean { let result: boolean = false; @@ -119,7 +119,7 @@ export interface RetryConfig { /** * Validates the retry config. - * @ignore + * @hidden */ function validateRetryConfig(config: RetryConfig): void { if (!config.operation) { diff --git a/sdk/core/core-amqp/src/util/checkNetworkConnection.browser.ts b/sdk/core/core-amqp/src/util/checkNetworkConnection.browser.ts index 880541c2c3f7..cf13ba983b60 100644 --- a/sdk/core/core-amqp/src/util/checkNetworkConnection.browser.ts +++ b/sdk/core/core-amqp/src/util/checkNetworkConnection.browser.ts @@ -3,7 +3,7 @@ /** * Checks whether a network connection is detected. - * @ignore + * @hidden * @internal */ export function checkNetworkConnection(): Promise { diff --git a/sdk/core/core-amqp/src/util/checkNetworkConnection.ts b/sdk/core/core-amqp/src/util/checkNetworkConnection.ts index cb67b28f4c97..988adda37994 100644 --- a/sdk/core/core-amqp/src/util/checkNetworkConnection.ts +++ b/sdk/core/core-amqp/src/util/checkNetworkConnection.ts @@ -6,7 +6,7 @@ import { logger } from "../log"; /** * Checks whether a network connection is detected. - * @ignore + * @hidden * @internal */ export function checkNetworkConnection(host: string): Promise { diff --git a/sdk/core/core-amqp/src/util/runtimeInfo.browser.ts b/sdk/core/core-amqp/src/util/runtimeInfo.browser.ts index 5344b3aa58f3..e02f0d6301ee 100644 --- a/sdk/core/core-amqp/src/util/runtimeInfo.browser.ts +++ b/sdk/core/core-amqp/src/util/runtimeInfo.browser.ts @@ -3,7 +3,7 @@ /** * @internal - * @ignore + * @hidden * * @interface Window */ @@ -11,13 +11,13 @@ interface Window {} /** * @internal - * @ignore + * @hidden */ declare let self: Window & typeof globalThis & { navigator: Navigator }; /** * @internal - * @ignore + * @hidden * * @interface Navigator */ @@ -30,7 +30,7 @@ interface Navigator { /** * Returns information about the platform this function is being run on. - * @ignore + * @hidden * @internal */ export function getPlatformInfo(): string { @@ -39,7 +39,7 @@ export function getPlatformInfo(): string { /** * Returns information about Node.js this function is being run on. - * @ignore + * @hidden * @internal */ export function getFrameworkInfo(): string { @@ -48,7 +48,7 @@ export function getFrameworkInfo(): string { /** * @internal - * @ignore + * @hidden * * @returns {string} */ diff --git a/sdk/core/core-amqp/src/util/runtimeInfo.ts b/sdk/core/core-amqp/src/util/runtimeInfo.ts index 871a23d32a95..4c33ce096ae1 100644 --- a/sdk/core/core-amqp/src/util/runtimeInfo.ts +++ b/sdk/core/core-amqp/src/util/runtimeInfo.ts @@ -5,7 +5,7 @@ import * as os from "os"; /** * Returns information about the platform this function is being run on. - * @ignore + * @hidden * @internal */ export function getPlatformInfo(): string { @@ -14,7 +14,7 @@ export function getPlatformInfo(): string { /** * Returns information about Node.js this function is being run on. - * @ignore + * @hidden * @internal */ export function getFrameworkInfo(): string { diff --git a/sdk/core/core-amqp/src/util/utils.ts b/sdk/core/core-amqp/src/util/utils.ts index 1f6c496ed7a8..958b3939220f 100644 --- a/sdk/core/core-amqp/src/util/utils.ts +++ b/sdk/core/core-amqp/src/util/utils.ts @@ -8,7 +8,7 @@ import { WebSocketImpl } from "rhea-promise"; export { AsyncLock }; /** * @internal - * @ignore + * @hidden * * Describes the options that can be provided to create an async lock. */ @@ -56,7 +56,7 @@ export interface WebSocketOptions { /** * @internal - * @ignore + * @hidden * * A constant that indicates whether the environment is node.js or browser based. */ @@ -117,7 +117,7 @@ export function parseConnectionString(connectionString: string): ParsedOutput /** * @internal - * @ignore + * @hidden * * Gets a new instance of the async lock with desired settings. * @param {AsyncLockOptions} [options] The async lock options. @@ -134,7 +134,7 @@ export const defaultLock: AsyncLock = new AsyncLock({ maxPending: 10000 }); /** * @internal - * @ignore + * @hidden * * Describes a Timeout class that can wait for the specified amount of time and then resolve/reject * the promise with the given value. @@ -236,7 +236,7 @@ export function delay( /** * @internal - * @ignore + * @hidden * * Generates a random number between the given interval * @param {number} min Min number of the range (inclusive). @@ -248,7 +248,7 @@ export function randomNumberFromInterval(min: number, max: number): number { /** * @internal - * @ignore + * @hidden * * Type declaration for a Function type where T is the input to the function and V is the output * of the function. @@ -257,7 +257,7 @@ export type Func = (a: T) => V; /** * @internal - * @ignore + * @hidden * * Executes an array of promises sequentially. Inspiration of this method is here: * https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. An awesome blog on promises! @@ -282,7 +282,7 @@ export function executePromisesSequentially( /** * @internal - * @ignore + * @hidden * * Determines whether the given connection string is an iothub connection string. * @param {string} connectionString The connection string. @@ -300,7 +300,7 @@ export function isIotHubConnectionString(connectionString: string): boolean { } /** - * @ignore + * @hidden * @internal */ export function isString(s: any): s is string { @@ -308,7 +308,7 @@ export function isString(s: any): s is string { } /** - * @ignore + * @hidden * @internal */ export function isNumber(n: any): n is number { diff --git a/sdk/core/core-amqp/tsdoc.json b/sdk/core/core-amqp/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/core/core-amqp/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/core/core-client/src/base64.ts b/sdk/core/core-client/src/base64.ts index 5a58a1993079..cbfb0ed91506 100644 --- a/sdk/core/core-client/src/base64.ts +++ b/sdk/core/core-client/src/base64.ts @@ -4,7 +4,7 @@ /** * Encodes a string in base64 format. * @param value the string to encode - * @internal @ignore + * @internal @hidden */ export function encodeString(value: string): string { return Buffer.from(value).toString("base64"); @@ -13,7 +13,7 @@ export function encodeString(value: string): string { /** * Encodes a byte array in base64 format. * @param value the Uint8Aray to encode - * @internal @ignore + * @internal @hidden */ export function encodeByteArray(value: Uint8Array): string { // Buffer.from accepts | -- the TypeScript definition is off here @@ -25,7 +25,7 @@ export function encodeByteArray(value: Uint8Array): string { /** * Decodes a base64 string into a byte array. * @param value the base64 string to decode - * @internal @ignore + * @internal @hidden */ export function decodeString(value: string): Uint8Array { return Buffer.from(value, "base64"); diff --git a/sdk/core/core-client/src/createSpan.ts b/sdk/core/core-client/src/createSpan.ts index 8d4d1a3a05c2..ba25b6a9dbfa 100644 --- a/sdk/core/core-client/src/createSpan.ts +++ b/sdk/core/core-client/src/createSpan.ts @@ -9,7 +9,7 @@ type OperationTracingOptions = OperationOptions["tracingOptions"]; /** * Creates a function called createSpan to create spans using the global tracer. - * @ignore + * @hidden * @param spanConfig The name of the operation being performed. * @param tracingOptions The options for the underlying http request. */ diff --git a/sdk/core/core-client/src/interfaceHelpers.ts b/sdk/core/core-client/src/interfaceHelpers.ts index 6e8647d87f43..77a38f01dffc 100644 --- a/sdk/core/core-client/src/interfaceHelpers.ts +++ b/sdk/core/core-client/src/interfaceHelpers.ts @@ -5,7 +5,7 @@ import { MapperTypeNames } from "./serializer"; import { OperationSpec, OperationParameter } from "./interfaces"; /** - * @internal @ignore + * @internal @hidden */ export function isStreamOperation(operationSpec: OperationSpec): boolean { for (const statusCode in operationSpec.responses) { @@ -24,7 +24,7 @@ export function isStreamOperation(operationSpec: OperationSpec): boolean { * Get the path to this parameter's value as a dotted string (a.b.c). * @param parameter The parameter to get the path string for. * @returns The path to this parameter's value as a dotted string. - * @internal @ignore + * @internal @hidden */ export function getPathStringFromParameter(parameter: OperationParameter): string { const { parameterPath, mapper } = parameter; diff --git a/sdk/core/core-client/src/operationHelpers.ts b/sdk/core/core-client/src/operationHelpers.ts index 20ef062f5506..2bb8feda8a89 100644 --- a/sdk/core/core-client/src/operationHelpers.ts +++ b/sdk/core/core-client/src/operationHelpers.ts @@ -10,7 +10,7 @@ import { } from "./interfaces"; /** - * @internal @ignore + * @internal @hidden * Retrieves the value to use for a given operation argument * @param operationArguments The arguments passed from the generated client * @param parameter The parameter description diff --git a/sdk/core/core-client/src/serializationPolicy.ts b/sdk/core/core-client/src/serializationPolicy.ts index f0f537199697..96df20d7ee88 100644 --- a/sdk/core/core-client/src/serializationPolicy.ts +++ b/sdk/core/core-client/src/serializationPolicy.ts @@ -90,7 +90,7 @@ function serializeHeaders( } /** - * @internal @ignore + * @internal @hidden */ export function serializeRequestBody( request: OperationRequest, diff --git a/sdk/core/core-client/src/utils.ts b/sdk/core/core-client/src/utils.ts index 743bf1e3b265..aa48cbe02c2e 100644 --- a/sdk/core/core-client/src/utils.ts +++ b/sdk/core/core-client/src/utils.ts @@ -5,7 +5,7 @@ * Returns true if the given value is a basic/primitive type * (string, number, boolean, null, undefined). * @param value Value to test - * @ignore @internal + * @hidden @internal */ export function isPrimitiveType(value: any): boolean { return (typeof value !== "object" && typeof value !== "function") || value === null; @@ -16,7 +16,7 @@ const validateISODuration = /^(-|\+)?P(?:([-+]?[0-9,.]*)Y)?(?:([-+]?[0-9,.]*)M)? /** * Returns true if the given string is in ISO 8601 format. * @param value The value to be validated for ISO 8601 duration format. - * @ignore @internal + * @hidden @internal */ export function isDuration(value: string): boolean { return validateISODuration.test(value); @@ -29,7 +29,7 @@ const validUuidRegex = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F * * @param uuid The uuid that needs to be validated. * - * @ignore @internal + * @hidden @internal */ export function isValidUuid(uuid: string): boolean { return validUuidRegex.test(uuid); diff --git a/sdk/core/core-client/tsdoc.json b/sdk/core/core-client/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/core/core-client/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/core/core-https/src/util/helpers.ts b/sdk/core/core-https/src/util/helpers.ts index dd0d77a6affd..efaad63065c9 100644 --- a/sdk/core/core-https/src/util/helpers.ts +++ b/sdk/core/core-https/src/util/helpers.ts @@ -24,7 +24,7 @@ export function delay(t: number, value?: T): Promise { * this for any kind of security purpose, find a better source of random. * @param min The smallest integer value allowed. * @param max The largest integer value allowed. - * @ignore @internal + * @hidden @internal */ export function getRandomIntegerInclusive(min: number, max: number): number { // Make sure inputs are integers. diff --git a/sdk/core/core-https/src/util/sanitizer.ts b/sdk/core/core-https/src/util/sanitizer.ts index 5684e3aebc51..719048347ccb 100644 --- a/sdk/core/core-https/src/util/sanitizer.ts +++ b/sdk/core/core-https/src/util/sanitizer.ts @@ -4,7 +4,7 @@ import { URL } from "./url"; /** - * @ignore @internal + * @hidden @internal */ export interface SanitizerOptions { /** @@ -23,7 +23,7 @@ export interface SanitizerOptions { } /** - * @ignore @internal + * @hidden @internal */ export type UnknownObject = { [s: string]: unknown }; @@ -73,7 +73,7 @@ const defaultAllowedHeaderNames = [ const defaultAllowedQueryParameters: string[] = ["api-version"]; /** - * @ignore @internal + * @hidden @internal */ export class Sanitizer { private allowedHeaderNames: Set; diff --git a/sdk/core/core-https/src/util/userAgent.ts b/sdk/core/core-https/src/util/userAgent.ts index a01a607ed003..d32211280292 100644 --- a/sdk/core/core-https/src/util/userAgent.ts +++ b/sdk/core/core-https/src/util/userAgent.ts @@ -14,14 +14,14 @@ function getUserAgentString(telemetryInfo: Map): string { } /** - * @ignore @internal + * @hidden @internal */ export function getUserAgentHeaderName(): string { return getHeaderName(); } /** - * @ignore @internal + * @hidden @internal */ export function getUserAgentValue(prefix?: string): string { const runtimeInfo = new Map(); diff --git a/sdk/core/core-https/src/util/userAgentPlatform.browser.ts b/sdk/core/core-https/src/util/userAgentPlatform.browser.ts index a20be51814cd..8b060ed26cc3 100644 --- a/sdk/core/core-https/src/util/userAgentPlatform.browser.ts +++ b/sdk/core/core-https/src/util/userAgentPlatform.browser.ts @@ -6,7 +6,7 @@ */ /** - * @ignore @internal + * @hidden @internal */ export function getHeaderName(): string { return "x-ms-useragent"; @@ -18,7 +18,7 @@ interface NavigatorEx extends Navigator { } /** - * @ignore @internal + * @hidden @internal */ export function setPlatformSpecificData(map: Map): void { const navigator = window.navigator as NavigatorEx; diff --git a/sdk/core/core-https/src/util/userAgentPlatform.ts b/sdk/core/core-https/src/util/userAgentPlatform.ts index 2451fa5af7ed..518eaee6fdf9 100644 --- a/sdk/core/core-https/src/util/userAgentPlatform.ts +++ b/sdk/core/core-https/src/util/userAgentPlatform.ts @@ -4,14 +4,14 @@ import * as os from "os"; /** - * @ignore @internal + * @hidden @internal */ export function getHeaderName(): string { return "User-Agent"; } /** - * @ignore @internal + * @hidden @internal */ export function setPlatformSpecificData(map: Map): void { map.set("Node", process.version); diff --git a/sdk/core/core-https/src/util/uuid.ts b/sdk/core/core-https/src/util/uuid.ts index 11784da0900d..6d65e487a0b3 100644 --- a/sdk/core/core-https/src/util/uuid.ts +++ b/sdk/core/core-https/src/util/uuid.ts @@ -7,7 +7,7 @@ import { v4 as uuidv4 } from "uuid"; * Generated Universally Unique Identifier * * @return RFC4122 v4 UUID. - * @ignore @internal + * @hidden @internal */ export function generateUuid(): string { return uuidv4(); diff --git a/sdk/core/core-https/tsdoc.json b/sdk/core/core-https/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/core/core-https/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/cosmosdb/cosmos/src/ClientContext.ts b/sdk/cosmosdb/cosmos/src/ClientContext.ts index fb7d7890c917..9548e1616909 100644 --- a/sdk/cosmosdb/cosmos/src/ClientContext.ts +++ b/sdk/cosmosdb/cosmos/src/ClientContext.ts @@ -30,7 +30,7 @@ const QueryJsonContentType = "application/query+json"; /** * @hidden - * @ignore + * @hidden */ export class ClientContext { private readonly sessionContainer: SessionContainer; @@ -45,7 +45,7 @@ export class ClientContext { this.sessionContainer = new SessionContainer(); this.partitionKeyDefinitionCache = {}; } - /** @ignore */ + /** @hidden */ public async read({ path, resourceType, diff --git a/sdk/cosmosdb/cosmos/src/auth.ts b/sdk/cosmosdb/cosmos/src/auth.ts index 8f6cf1ffa710..2d2d2831f122 100644 --- a/sdk/cosmosdb/cosmos/src/auth.ts +++ b/sdk/cosmosdb/cosmos/src/auth.ts @@ -23,7 +23,7 @@ export interface RequestInfo { export type TokenProvider = (requestInfo: RequestInfo) => Promise; /** - * @ignore + * @hidden * @param clientOptions * @param verb * @param path @@ -73,7 +73,7 @@ export async function setAuthorizationHeader( /** * The default function for setting header token using the masterKey - * @ignore + * @hidden */ export async function setAuthorizationTokenHeaderUsingMasterKey( verb: HTTPMethod, @@ -93,7 +93,7 @@ export async function setAuthorizationTokenHeaderUsingMasterKey( } /** - * @ignore + * @hidden * @param resourceTokens * @param path * @param resourceId diff --git a/sdk/cosmosdb/cosmos/src/client/Container/Container.ts b/sdk/cosmosdb/cosmos/src/client/Container/Container.ts index edd0fff70271..53313d58677b 100644 --- a/sdk/cosmosdb/cosmos/src/client/Container/Container.ts +++ b/sdk/cosmosdb/cosmos/src/client/Container/Container.ts @@ -185,7 +185,7 @@ export class Container { /** * Gets the partition key definition first by looking into the cache otherwise by reading the collection. - * @ignore + * @hidden * @param {string} collectionLink - Link to the collection whose partition key needs to be extracted. * @param {function} callback - \ * The arguments to the callback are(in order): error, partitionKeyDefinition, response object and response headers diff --git a/sdk/cosmosdb/cosmos/src/client/Container/PartitionKeyRange.ts b/sdk/cosmosdb/cosmos/src/client/Container/PartitionKeyRange.ts index 39cff5142e26..0773282179e7 100644 --- a/sdk/cosmosdb/cosmos/src/client/Container/PartitionKeyRange.ts +++ b/sdk/cosmosdb/cosmos/src/client/Container/PartitionKeyRange.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. /** - * @ignore + * @hidden */ export interface PartitionKeyRange { id: string; diff --git a/sdk/cosmosdb/cosmos/src/client/Item/Items.ts b/sdk/cosmosdb/cosmos/src/client/Item/Items.ts index a46e3fee45bd..a6623a8277ec 100644 --- a/sdk/cosmosdb/cosmos/src/client/Item/Items.ts +++ b/sdk/cosmosdb/cosmos/src/client/Item/Items.ts @@ -26,7 +26,7 @@ import { hashV1PartitionKey } from "../../utils/hashing/v1"; import { hashV2PartitionKey } from "../../utils/hashing/v2"; /** - * @ignore + * @hidden * @param options */ function isChangeFeedOptions(options: unknown): options is ChangeFeedOptions { diff --git a/sdk/cosmosdb/cosmos/src/common/constants.ts b/sdk/cosmosdb/cosmos/src/common/constants.ts index 32b66ff82548..1e3db5338156 100644 --- a/sdk/cosmosdb/cosmos/src/common/constants.ts +++ b/sdk/cosmosdb/cosmos/src/common/constants.ts @@ -2,7 +2,7 @@ // Licensed under the MIT license. /** - * @ignore + * @hidden */ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. @@ -218,7 +218,7 @@ export const Constants = { }; /** - * @ignore + * @hidden */ export enum ResourceType { none = "", @@ -236,7 +236,7 @@ export enum ResourceType { } /** - * @ignore + * @hidden */ export enum HTTPMethod { get = "GET", @@ -246,7 +246,7 @@ export enum HTTPMethod { } /** - * @ignore + * @hidden */ export enum OperationType { Create = "create", diff --git a/sdk/cosmosdb/cosmos/src/common/helper.ts b/sdk/cosmosdb/cosmos/src/common/helper.ts index e3cc603fbd6a..af43845bc798 100644 --- a/sdk/cosmosdb/cosmos/src/common/helper.ts +++ b/sdk/cosmosdb/cosmos/src/common/helper.ts @@ -17,7 +17,7 @@ export function jsonStringifyAndEscapeNonASCII(arg: any) { } /** - * @ignore + * @hidden */ export function parseLink(resourcePath: string) { if (resourcePath.length === 0) { @@ -72,14 +72,14 @@ export function parseLink(resourcePath: string) { } /** - * @ignore + * @hidden */ export function isReadRequest(operationType: OperationType): boolean { return operationType === OperationType.Read || operationType === OperationType.Query; } /** - * @ignore + * @hidden */ export function sleep(time: number): Promise { return new Promise((resolve) => { @@ -90,7 +90,7 @@ export function sleep(time: number): Promise { } /** - * @ignore + * @hidden */ export function getContainerLink(link: string) { return link @@ -100,21 +100,21 @@ export function getContainerLink(link: string) { } /** - * @ignore + * @hidden */ export function trimSlashes(source: string) { return source.replace(trimLeftSlashes, "").replace(trimRightSlashes, ""); } /** - * @ignore + * @hidden */ export function getHexaDigit() { return Math.floor(Math.random() * 16).toString(16); } /** - * @ignore + * @hidden */ export function parsePath(path: string) { const pathParts = []; @@ -181,7 +181,7 @@ export function parsePath(path: string) { } /** - * @ignore + * @hidden */ export function isResourceValid(resource: any, err: any) { // TODO: any TODO: code smell @@ -208,13 +208,13 @@ export function isResourceValid(resource: any, err: any) { return true; } -/** @ignore */ +/** @hidden */ export function getIdFromLink(resourceLink: string) { resourceLink = trimSlashes(resourceLink); return resourceLink; } -/** @ignore */ +/** @hidden */ export function getPathFromLink(resourceLink: string, resourceType?: string) { resourceLink = trimSlashes(resourceLink); if (resourceType) { @@ -225,7 +225,7 @@ export function getPathFromLink(resourceLink: string, resourceType?: string) { } /** - * @ignore + * @hidden */ export function isStringNullOrEmpty(inputString: string) { // checks whether string is null, undefined, empty or only contains space @@ -233,7 +233,7 @@ export function isStringNullOrEmpty(inputString: string) { } /** - * @ignore + * @hidden */ export function trimSlashFromLeftAndRight(inputString: string) { if (typeof inputString !== "string") { @@ -244,7 +244,7 @@ export function trimSlashFromLeftAndRight(inputString: string) { } /** - * @ignore + * @hidden */ export function validateResourceId(resourceId: string) { // if resourceId is not a string or is empty throw an error @@ -266,7 +266,7 @@ export function validateResourceId(resourceId: string) { } /** - * @ignore + * @hidden * @param resourcePath */ export function getResourceIdFromPath(resourcePath: string) { @@ -286,7 +286,7 @@ export function getResourceIdFromPath(resourcePath: string) { } /** - * @ignore + * @hidden */ interface ConnectionObject { AccountEndpoint: string; @@ -294,7 +294,7 @@ interface ConnectionObject { } /** - * @ignore + * @hidden */ export function parseConnectionString(connectionString: string): CosmosClientOptions { const keyValueStrings = connectionString.split(";"); diff --git a/sdk/cosmosdb/cosmos/src/common/platform.ts b/sdk/cosmosdb/cosmos/src/common/platform.ts index 431bd768b931..9d744f083ed2 100644 --- a/sdk/cosmosdb/cosmos/src/common/platform.ts +++ b/sdk/cosmosdb/cosmos/src/common/platform.ts @@ -4,7 +4,7 @@ import { getUserAgent as userAgent } from "universal-user-agent"; import { Constants } from "./constants"; /** - * @ignore + * @hidden */ export function getUserAgent(suffix?: string) { const ua = `${userAgent()} ${Constants.SDKName}/${Constants.SDKVersion}`; diff --git a/sdk/cosmosdb/cosmos/src/common/statusCodes.ts b/sdk/cosmosdb/cosmos/src/common/statusCodes.ts index e2a1b0745374..d070c4a75521 100644 --- a/sdk/cosmosdb/cosmos/src/common/statusCodes.ts +++ b/sdk/cosmosdb/cosmos/src/common/statusCodes.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. /** - * @ignore + * @hidden */ export const StatusCodes = { // Success @@ -35,7 +35,7 @@ export const StatusCodes = { }; /** - * @ignore + * @hidden */ export const SubStatusCodes = { Unknown: 0 as 0, diff --git a/sdk/cosmosdb/cosmos/src/common/uriFactory.ts b/sdk/cosmosdb/cosmos/src/common/uriFactory.ts index 2051839790e2..a334a2eceacc 100644 --- a/sdk/cosmosdb/cosmos/src/common/uriFactory.ts +++ b/sdk/cosmosdb/cosmos/src/common/uriFactory.ts @@ -4,7 +4,7 @@ import { Constants } from "./constants"; import { trimSlashFromLeftAndRight, validateResourceId } from "./helper"; /** - * @ignore + * @hidden * Given a database id, this creates a database link. * @param {string} databaseId -The database id * @returns {string} -A database link in the format of dbs/{0} \ @@ -28,7 +28,7 @@ export function createDatabaseUri(databaseId: string) { * @description Would be used when updating or deleting a DocumentCollection, creating a \ * Document, a StoredProcedure, a Trigger, a UserDefinedFunction, or when executing a query \ * with CreateDocumentQuery in Azure Cosmos DB database service. - * @ignore + * @hidden */ export function createDocumentCollectionUri(databaseId: string, collectionId: string) { collectionId = trimSlashFromLeftAndRight(collectionId); @@ -47,7 +47,7 @@ export function createDocumentCollectionUri(databaseId: string, collectionId: st * with {0} being a Uri escaped version of the databaseId and {1} being userId * @description Would be used when creating a Permission, or when replacing or deleting \ * a User in Azure Cosmos DB database service - * @ignore + * @hidden */ export function createUserUri(databaseId: string, userId: string) { userId = trimSlashFromLeftAndRight(userId); @@ -66,7 +66,7 @@ export function createUserUri(databaseId: string, userId: string) { * the databaseId, {1} being collectionId and {2} being the documentId * @description Would be used when creating an Attachment, or when replacing \ * or deleting a Document in Azure Cosmos DB database service - * @ignore + * @hidden */ export function createDocumentUri(databaseId: string, collectionId: string, documentId: string) { documentId = trimSlashFromLeftAndRight(documentId); @@ -89,7 +89,7 @@ export function createDocumentUri(databaseId: string, collectionId: string, docu * @returns {string} A permission link in the format of dbs/{0}/users/{1}/permissions/{2} \ * with {0} being a Uri escaped version of the databaseId, {1} being userId and {2} being permissionId * @description Would be used when replacing or deleting a Permission in Azure Cosmos DB database service. - * @ignore + * @hidden */ export function createPermissionUri(databaseId: string, userId: string, permissionId: string) { permissionId = trimSlashFromLeftAndRight(permissionId); @@ -114,7 +114,7 @@ export function createPermissionUri(databaseId: string, userId: string, permissi * {1} being collectionId and {2} being the storedProcedureId * @description Would be used when replacing, executing, or deleting a StoredProcedure in \ * Azure Cosmos DB database service. - * @ignore + * @hidden */ export function createStoredProcedureUri( databaseId: string, @@ -142,7 +142,7 @@ export function createStoredProcedureUri( * dbs/{0}/colls/{1}/triggers/{2} with {0} being a Uri escaped version of the databaseId, \ * {1} being collectionId and {2} being the triggerId * @description Would be used when replacing, executing, or deleting a Trigger in Azure Cosmos DB database service - * @ignore + * @hidden */ export function createTriggerUri(databaseId: string, collectionId: string, triggerId: string) { triggerId = trimSlashFromLeftAndRight(triggerId); @@ -166,7 +166,7 @@ export function createTriggerUri(databaseId: string, collectionId: string, trigg * with {0} being a Uri escaped version of the databaseId, {1} being collectionId and {2} being the udfId * @description Would be used when replacing, executing, or deleting a UserDefinedFunction in \ * Azure Cosmos DB database service - * @ignore + * @hidden */ export function createUserDefinedFunctionUri( databaseId: string, @@ -193,7 +193,7 @@ export function createUserDefinedFunctionUri( * @returns {string} -A conflict link in the format of dbs/{0}/colls/{1}/conflicts/{2} \ * with {0} being a Uri escaped version of the databaseId, {1} being collectionId and {2} being the conflictId * @description Would be used when creating a Conflict in Azure Cosmos DB database service. - * @ignore + * @hidden */ export function createConflictUri(databaseId: string, collectionId: string, conflictId: string) { conflictId = trimSlashFromLeftAndRight(conflictId); @@ -217,7 +217,7 @@ export function createConflictUri(databaseId: string, collectionId: string, conf * @returns {string} -A conflict link in the format of dbs/{0}/colls/{1}/conflicts/{2} \ * with {0} being a Uri escaped version of the databaseId, {1} being collectionId and {2} being the conflictId * @description Would be used when creating a Conflict in Azure Cosmos DB database service. - * @ignore + * @hidden */ export function createAttachmentUri( databaseId: string, @@ -244,7 +244,7 @@ export function createAttachmentUri( * @param {string} collectionId -The collection Id * @returns {string} -A partition key ranges link in the format of \ * dbs/{0}/colls/{1}/pkranges with {0} being a Uri escaped version of the databaseId and {1} being collectionId - * @ignore + * @hidden */ export function createPartitionKeyRangesUri(databaseId: string, collectionId: string) { return ( diff --git a/sdk/cosmosdb/cosmos/src/documents/ConnectionPolicy.ts b/sdk/cosmosdb/cosmos/src/documents/ConnectionPolicy.ts index 0a3fa90b4dea..d287bd9fc4b2 100644 --- a/sdk/cosmosdb/cosmos/src/documents/ConnectionPolicy.ts +++ b/sdk/cosmosdb/cosmos/src/documents/ConnectionPolicy.ts @@ -24,7 +24,7 @@ export interface ConnectionPolicy { } /** - * @ignore + * @hidden */ export const defaultConnectionPolicy = Object.freeze({ connectionMode: ConnectionMode.Gateway, diff --git a/sdk/cosmosdb/cosmos/src/extractPartitionKey.ts b/sdk/cosmosdb/cosmos/src/extractPartitionKey.ts index 0d493e414fd0..c8eb5d784d92 100644 --- a/sdk/cosmosdb/cosmos/src/extractPartitionKey.ts +++ b/sdk/cosmosdb/cosmos/src/extractPartitionKey.ts @@ -4,7 +4,7 @@ import { parsePath } from "./common"; import { PartitionKey, PartitionKeyDefinition } from "./documents"; /** - * @ignore + * @hidden * @param document * @param partitionKeyDefinition */ @@ -37,7 +37,7 @@ export function extractPartitionKey( } } /** - * @ignore + * @hidden * @param partitionKeyDefinition */ export function undefinedPartitionKey(partitionKeyDefinition: PartitionKeyDefinition) { diff --git a/sdk/cosmosdb/cosmos/src/plugins/Plugin.ts b/sdk/cosmosdb/cosmos/src/plugins/Plugin.ts index 59b150c1b7b1..c518f97c2733 100644 --- a/sdk/cosmosdb/cosmos/src/plugins/Plugin.ts +++ b/sdk/cosmosdb/cosmos/src/plugins/Plugin.ts @@ -6,7 +6,7 @@ import { Response } from "../request/Response"; /** * Used to specify which type of events to execute this plug in on. * - * @ignore + * @hidden */ export enum PluginOn { /** @@ -22,7 +22,7 @@ export enum PluginOn { /** * Specifies which event to run for the specified plugin * - * @ignore + * @hidden */ export interface PluginConfig { /** @@ -46,21 +46,21 @@ export interface PluginConfig { * RequestContext is an object which controls what operation is happening, against which endpoint, and more. Modifying this and passing it along via next is how * you modify future SDK behavior. * - * @ignore + * @hidden */ export type Plugin = (context: RequestContext, next: Next) => Promise>; /** * Next is a function which takes in requestContext returns a promise. You must await/then that promise which will contain the response from further plugins, * allowing you to log those results or handle errors. - * @ignore + * @hidden */ export type Next = (context: RequestContext) => Promise>; /** * @internal * @hidden - * @ignore + * @hidden * @param requestContext * @param next * @param on diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/CountAggregator.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/CountAggregator.ts index a63819b5d3bd..ee2d82dcaf39 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/CountAggregator.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/CountAggregator.ts @@ -8,7 +8,7 @@ export class CountAggregator implements Aggregator { /** * Represents an aggregator for COUNT operator. * @constructor CountAggregator - * @ignore + * @hidden */ constructor() { this.value = 0; diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/MaxAggregator.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/MaxAggregator.ts index 5e10bdc9f72a..915cf5c63639 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/MaxAggregator.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/MaxAggregator.ts @@ -15,7 +15,7 @@ export class MaxAggregator implements Aggregator { /** * Represents an aggregator for MAX operator. * @constructor MaxAggregator - * @ignore + * @hidden */ constructor() { this.value = undefined; diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/MinAggregator.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/MinAggregator.ts index e2961e788224..9c4d5a3218d5 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/MinAggregator.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/Aggregators/MinAggregator.ts @@ -15,7 +15,7 @@ export class MinAggregator implements Aggregator { /** * Represents an aggregator for MIN operator. * @constructor MinAggregator - * @ignore + * @hidden */ constructor() { this.value = undefined; diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/EndpointComponent/OrderByEndpointComponent.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/EndpointComponent/OrderByEndpointComponent.ts index bd80133f0d76..33fb8865bf1a 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/EndpointComponent/OrderByEndpointComponent.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/EndpointComponent/OrderByEndpointComponent.ts @@ -10,7 +10,7 @@ export class OrderByEndpointComponent implements ExecutionContext { * result it returns 'payload' item of the result * @constructor OrderByEndpointComponent * @param {object} executionContext - Underlying Execution Context - * @ignore + * @hidden */ constructor(private executionContext: ExecutionContext) {} /** diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/FetchResult.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/FetchResult.ts index 4800c42a1aac..f196629a32fd 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/FetchResult.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/FetchResult.ts @@ -18,7 +18,7 @@ export class FetchResult { * @constructor DocumentProducer * @param {object} feedReponse - The response the document producer got back on a successful fetch * @param {object} error - The exception meant to be buffered on an unsuccessful fetch - * @ignore + * @hidden */ constructor(feedResponse: any, error: any) { // TODO: feedResponse/error diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/defaultQueryExecutionContext.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/defaultQueryExecutionContext.ts index 1fa36d1c5e35..553a0b2573d0 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/defaultQueryExecutionContext.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/defaultQueryExecutionContext.ts @@ -43,7 +43,7 @@ export class DefaultQueryExecutionContext implements ExecutionContext { * @param {FeedOptions} [options] - Represents the feed options. * @param {callback | callback[]} fetchFunctions - A function to retrieve each page of data. * An array of functions may be used to query more than one partition. - * @ignore + * @hidden */ constructor(options: any, fetchFunctions: FetchFunctionCallback | FetchFunctionCallback[]) { // TODO: any options diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/documentProducer.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/documentProducer.ts index df24adb384bd..261de267def8 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/documentProducer.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/documentProducer.ts @@ -37,7 +37,7 @@ export class DocumentProducer { * @param {String} collectionLink - Represents collection link * @param {SqlQuerySpec | string} query - A SQL query. * @param {object} targetPartitionKeyRange - Query Target Partition key Range - * @ignore + * @hidden */ constructor( private clientContext: ClientContext, @@ -65,7 +65,7 @@ export class DocumentProducer { /** * Synchronously gives the contiguous buffered results (stops at the first non result) if any * @returns {Object} - buffered current items if any - * @ignore + * @hidden */ public peekBufferedItems() { const bufferedResults = []; @@ -205,7 +205,7 @@ export class DocumentProducer { /** * Synchronously gives the bufferend current item if any * @returns {Object} - buffered current item if any - * @ignore + * @hidden */ public getTargetParitionKeyRange() { return this.targetPartitionKeyRange; diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/headerUtils.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/headerUtils.ts index 5e35f06f4b15..bfa1442c9b63 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/headerUtils.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/headerUtils.ts @@ -29,7 +29,7 @@ export function getRequestChargeIfAny(headers: CosmosHeaders | number): number { } /** - * @ignore + * @hidden */ export function getInitialHeader(): CosmosHeaders { const headers: CosmosHeaders = {}; @@ -39,7 +39,7 @@ export function getInitialHeader(): CosmosHeaders { } /** - * @ignore + * @hidden * @param headers * @param toBeMergedHeaders */ diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/orderByQueryExecutionContext.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/orderByQueryExecutionContext.ts index eaf6474616e2..db524ebdfb49 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/orderByQueryExecutionContext.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/orderByQueryExecutionContext.ts @@ -23,7 +23,7 @@ export class OrderByQueryExecutionContext extends ParallelQueryExecutionContextB * @param {string} collectionLink - The Collection Link * @param {FeedOptions} [options] - Represents the feed options. * @param {object} partitionedQueryExecutionInfo - PartitionedQueryExecutionInfo - * @ignore + * @hidden */ constructor( clientContext: ClientContext, @@ -42,7 +42,7 @@ export class OrderByQueryExecutionContext extends ParallelQueryExecutionContextB /** * Provides a Comparator for document producers which respects orderby sort order. * @returns {object} - Comparator Function - * @ignore + * @hidden */ public documentProducerComparator(docProd1: DocumentProducer, docProd2: DocumentProducer) { return this.orderByComparator.compare(docProd1, docProd2); diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/parallelQueryExecutionContext.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/parallelQueryExecutionContext.ts index 24a8c9bad44c..16f249140323 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/parallelQueryExecutionContext.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/parallelQueryExecutionContext.ts @@ -18,7 +18,7 @@ export class ParallelQueryExecutionContext extends ParallelQueryExecutionContext * @param {string} collectionLink - The Collection Link * @param {FeedOptions} [options] - Represents the feed options. * @param {object} partitionedQueryExecutionInfo - PartitionedQueryExecutionInfo - * @ignore + * @hidden */ constructor( clientContext: ClientContext, @@ -36,7 +36,7 @@ export class ParallelQueryExecutionContext extends ParallelQueryExecutionContext /** * Provides a Comparator for document producers using the min value of the corresponding target partition. * @returns {object} - Comparator Function - * @ignore + * @hidden */ public documentProducerComparator(docProd1: DocumentProducer, docProd2: DocumentProducer) { return docProd1.generation - docProd2.generation; diff --git a/sdk/cosmosdb/cosmos/src/queryExecutionContext/parallelQueryExecutionContextBase.ts b/sdk/cosmosdb/cosmos/src/queryExecutionContext/parallelQueryExecutionContextBase.ts index 2512a98b3dd5..dd720ab35e0e 100644 --- a/sdk/cosmosdb/cosmos/src/queryExecutionContext/parallelQueryExecutionContextBase.ts +++ b/sdk/cosmosdb/cosmos/src/queryExecutionContext/parallelQueryExecutionContextBase.ts @@ -48,7 +48,7 @@ export abstract class ParallelQueryExecutionContextBase implements ExecutionCont * @param {string} collectionLink - The Collection Link * @param {FeedOptions} [options] - Represents the feed options. * @param {object} partitionedQueryExecutionInfo - PartitionedQueryExecutionInfo - * @ignore + * @hidden */ constructor( private clientContext: ClientContext, diff --git a/sdk/cosmosdb/cosmos/src/queryMetrics/queryMetrics.ts b/sdk/cosmosdb/cosmos/src/queryMetrics/queryMetrics.ts index ec089e0f2495..ce0e31131770 100644 --- a/sdk/cosmosdb/cosmos/src/queryMetrics/queryMetrics.ts +++ b/sdk/cosmosdb/cosmos/src/queryMetrics/queryMetrics.ts @@ -28,7 +28,7 @@ export class QueryMetrics { * Gets the IndexHitRatio * @memberof QueryMetrics * @instance - * @ignore + * @hidden */ public get indexHitRatio() { return this.retrievedDocumentCount === 0 @@ -95,7 +95,7 @@ export class QueryMetrics { * Output the QueryMetrics as a delimited string. * @memberof QueryMetrics * @instance - * @ignore + * @hidden */ public toDelimitedString() { return ( diff --git a/sdk/cosmosdb/cosmos/src/queryMetrics/queryMetricsUtils.ts b/sdk/cosmosdb/cosmos/src/queryMetrics/queryMetricsUtils.ts index 4147fdc43342..c70affb67ce4 100644 --- a/sdk/cosmosdb/cosmos/src/queryMetrics/queryMetricsUtils.ts +++ b/sdk/cosmosdb/cosmos/src/queryMetrics/queryMetricsUtils.ts @@ -3,7 +3,7 @@ import { TimeSpan } from "./timeSpan"; /** - * @ignore + * @hidden * @param delimitedString */ export function parseDelimitedString(delimitedString: string) { @@ -31,7 +31,7 @@ export function parseDelimitedString(delimitedString: string) { } /** - * @ignore + * @hidden * @param metrics * @param key */ @@ -44,7 +44,7 @@ export function timeSpanFromMetrics(metrics: { [key: string]: any } /* TODO: any } /** - * @ignore + * @hidden * @param input */ export function isNumeric(input: any) { diff --git a/sdk/cosmosdb/cosmos/src/queryMetrics/timeSpan.ts b/sdk/cosmosdb/cosmos/src/queryMetrics/timeSpan.ts index fd70abaf24ca..06d9621ba737 100644 --- a/sdk/cosmosdb/cosmos/src/queryMetrics/timeSpan.ts +++ b/sdk/cosmosdb/cosmos/src/queryMetrics/timeSpan.ts @@ -53,7 +53,7 @@ const minMilliSeconds = Number.MIN_SAFE_INTEGER / ticksPerMillisecond; * @param {number} minutes - Number of minutes. * @param {number} seconds - Number of seconds. * @param {number} milliseconds - Number of milliseconds. - * @ignore + * @hidden */ export class TimeSpan { // tslint:disable-next-line:variable-name diff --git a/sdk/cosmosdb/cosmos/src/request/ErrorResponse.ts b/sdk/cosmosdb/cosmos/src/request/ErrorResponse.ts index bef8b56207bd..c9cef67f21a8 100644 --- a/sdk/cosmosdb/cosmos/src/request/ErrorResponse.ts +++ b/sdk/cosmosdb/cosmos/src/request/ErrorResponse.ts @@ -6,13 +6,13 @@ export interface ErrorBody { code: string; message: string; /** - * @ignore + * @hidden */ additionalErrorInfo?: PartitionedQueryExecutionInfo; } /** - * @ignore + * @hidden */ export interface PartitionedQueryExecutionInfo { partitionedQueryExecutionInfoVersion: number; @@ -21,7 +21,7 @@ export interface PartitionedQueryExecutionInfo { } /** - * @ignore + * @hidden */ export interface QueryRange { min: string; @@ -31,7 +31,7 @@ export interface QueryRange { } /** - * @ignore + * @hidden */ export interface QueryInfo { top?: any; diff --git a/sdk/cosmosdb/cosmos/src/request/RequestContext.ts b/sdk/cosmosdb/cosmos/src/request/RequestContext.ts index 04af709e020a..fa84f07ce359 100644 --- a/sdk/cosmosdb/cosmos/src/request/RequestContext.ts +++ b/sdk/cosmosdb/cosmos/src/request/RequestContext.ts @@ -11,7 +11,7 @@ import { FeedOptions } from "./FeedOptions"; import { RequestOptions } from "./RequestOptions"; /** - * @ignore + * @hidden */ export interface RequestContext { path?: string; diff --git a/sdk/cosmosdb/cosmos/src/request/RequestHandler.ts b/sdk/cosmosdb/cosmos/src/request/RequestHandler.ts index 608496921b94..645afa7ff6ee 100644 --- a/sdk/cosmosdb/cosmos/src/request/RequestHandler.ts +++ b/sdk/cosmosdb/cosmos/src/request/RequestHandler.ts @@ -22,7 +22,7 @@ async function executeRequest(requestContext: RequestContext) { } /** - * @ignore + * @hidden * @param requestContext */ async function httpRequest(requestContext: RequestContext) { @@ -134,7 +134,7 @@ async function httpRequest(requestContext: RequestContext) { } /** - * @ignore + * @hidden * @param requestContext */ export async function request(requestContext: RequestContext): Promise> { diff --git a/sdk/cosmosdb/cosmos/src/request/Response.ts b/sdk/cosmosdb/cosmos/src/request/Response.ts index 7fbddfa21205..dcc1e0371c43 100644 --- a/sdk/cosmosdb/cosmos/src/request/Response.ts +++ b/sdk/cosmosdb/cosmos/src/request/Response.ts @@ -3,7 +3,7 @@ import { CosmosHeaders } from "../index"; /** - * @ignore + * @hidden */ export interface Response { headers: CosmosHeaders; diff --git a/sdk/cosmosdb/cosmos/src/request/StatusCodes.ts b/sdk/cosmosdb/cosmos/src/request/StatusCodes.ts index fc802b747a24..3d7ceed77e82 100644 --- a/sdk/cosmosdb/cosmos/src/request/StatusCodes.ts +++ b/sdk/cosmosdb/cosmos/src/request/StatusCodes.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. /** - * @ignore + * @hidden */ export const StatusCode = { // Success @@ -35,12 +35,12 @@ export const StatusCode = { }; /** - * @ignore + * @hidden */ export type StatusCode = typeof StatusCode[keyof typeof StatusCode]; /** - * @ignore + * @hidden */ export const SubStatusCode = { Unknown: 0 as 0, diff --git a/sdk/cosmosdb/cosmos/src/request/TimeoutError.ts b/sdk/cosmosdb/cosmos/src/request/TimeoutError.ts index 8bea1d4785be..45ecfd6cab5d 100644 --- a/sdk/cosmosdb/cosmos/src/request/TimeoutError.ts +++ b/sdk/cosmosdb/cosmos/src/request/TimeoutError.ts @@ -1,7 +1,7 @@ // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. /** - * @ignore + * @hidden */ export const TimeoutErrorCode = "TimeoutError"; diff --git a/sdk/cosmosdb/cosmos/src/request/defaultAgent.browser.ts b/sdk/cosmosdb/cosmos/src/request/defaultAgent.browser.ts index 5a6dd894a397..f47a9aa12d61 100644 --- a/sdk/cosmosdb/cosmos/src/request/defaultAgent.browser.ts +++ b/sdk/cosmosdb/cosmos/src/request/defaultAgent.browser.ts @@ -2,10 +2,10 @@ // Licensed under the MIT license. import { Agent } from "http"; /** - * @ignore + * @hidden */ export let defaultHttpAgent: Agent; /** - * @ignore + * @hidden */ export let defaultHttpsAgent: Agent; diff --git a/sdk/cosmosdb/cosmos/src/request/defaultAgent.ts b/sdk/cosmosdb/cosmos/src/request/defaultAgent.ts index 699326dfc5ad..c9224e652222 100644 --- a/sdk/cosmosdb/cosmos/src/request/defaultAgent.ts +++ b/sdk/cosmosdb/cosmos/src/request/defaultAgent.ts @@ -3,11 +3,11 @@ import { Agent } from "http"; /** - * @ignore + * @hidden */ export let defaultHttpAgent: Agent; /** - * @ignore + * @hidden */ export let defaultHttpsAgent: Agent; diff --git a/sdk/cosmosdb/cosmos/src/request/request.ts b/sdk/cosmosdb/cosmos/src/request/request.ts index 23c2dffa8c81..4e3605460fb1 100644 --- a/sdk/cosmosdb/cosmos/src/request/request.ts +++ b/sdk/cosmosdb/cosmos/src/request/request.ts @@ -29,7 +29,7 @@ export function bodyFromData(data: Buffer | string | object) { } /** - * @ignore + * @hidden */ interface GetHeadersOptions { clientOptions: CosmosClientOptions; @@ -47,7 +47,7 @@ interface GetHeadersOptions { const JsonContentType = "application/json"; /** - * @ignore + * @hidden * @param param0 */ export async function getHeaders({ diff --git a/sdk/cosmosdb/cosmos/src/retry/RetryPolicy.ts b/sdk/cosmosdb/cosmos/src/retry/RetryPolicy.ts index b5b43c7cbd52..3ff89d6c433c 100644 --- a/sdk/cosmosdb/cosmos/src/retry/RetryPolicy.ts +++ b/sdk/cosmosdb/cosmos/src/retry/RetryPolicy.ts @@ -4,7 +4,7 @@ import { ErrorResponse } from "../request"; import { RetryContext } from "./RetryContext"; /** - * @ignore + * @hidden */ export interface RetryPolicy { retryAfterInMs: number; diff --git a/sdk/cosmosdb/cosmos/src/retry/defaultRetryPolicy.ts b/sdk/cosmosdb/cosmos/src/retry/defaultRetryPolicy.ts index b9bfe46d06c6..20ac672f94b1 100644 --- a/sdk/cosmosdb/cosmos/src/retry/defaultRetryPolicy.ts +++ b/sdk/cosmosdb/cosmos/src/retry/defaultRetryPolicy.ts @@ -6,84 +6,84 @@ import { TimeoutErrorCode } from "../request/TimeoutError"; import { RetryPolicy } from "./RetryPolicy"; /** - * @ignore + * @hidden */ // Windows Socket Error Codes const WindowsInterruptedFunctionCall = 10004; /** - * @ignore + * @hidden */ const WindowsFileHandleNotValid = 10009; /** - * @ignore + * @hidden */ const WindowsPermissionDenied = 10013; /** - * @ignore + * @hidden */ const WindowsBadAddress = 10014; /** - * @ignore + * @hidden */ const WindowsInvalidArgumnet = 10022; /** - * @ignore + * @hidden */ const WindowsResourceTemporarilyUnavailable = 10035; /** - * @ignore + * @hidden */ const WindowsOperationNowInProgress = 10036; /** - * @ignore + * @hidden */ const WindowsAddressAlreadyInUse = 10048; /** - * @ignore + * @hidden */ const WindowsConnectionResetByPeer = 10054; /** - * @ignore + * @hidden */ const WindowsCannotSendAfterSocketShutdown = 10058; /** - * @ignore + * @hidden */ const WindowsConnectionTimedOut = 10060; /** - * @ignore + * @hidden */ const WindowsConnectionRefused = 10061; /** - * @ignore + * @hidden */ const WindowsNameTooLong = 10063; /** - * @ignore + * @hidden */ const WindowsHostIsDown = 10064; /** - * @ignore + * @hidden */ const WindowsNoRouteTohost = 10065; /** - * @ignore + * @hidden */ // Linux Error Codes /** - * @ignore + * @hidden */ const LinuxConnectionReset = "ECONNRESET"; // Node Error Codes /** - * @ignore + * @hidden */ const BrokenPipe = "EPIPE"; /** - * @ignore + * @hidden */ const CONNECTION_ERROR_CODES = [ WindowsInterruptedFunctionCall, @@ -107,7 +107,7 @@ const CONNECTION_ERROR_CODES = [ ]; /** - * @ignore + * @hidden */ function needsRetry(operationType: OperationType, code: number | string) { if ( @@ -124,7 +124,7 @@ function needsRetry(operationType: OperationType, code: number | string) { * This class implements the default connection retry policy for requests. * @property {int} currentRetryAttemptCount - Current retry attempt count. * @hidden - * @ignore + * @hidden */ export class DefaultRetryPolicy implements RetryPolicy { private maxTries: number = 10; diff --git a/sdk/cosmosdb/cosmos/src/retry/retryUtility.ts b/sdk/cosmosdb/cosmos/src/retry/retryUtility.ts index 861ebaacd16d..7d41887fe636 100644 --- a/sdk/cosmosdb/cosmos/src/retry/retryUtility.ts +++ b/sdk/cosmosdb/cosmos/src/retry/retryUtility.ts @@ -13,7 +13,7 @@ import { RetryPolicy } from "./RetryPolicy"; import { SessionRetryPolicy } from "./sessionRetryPolicy"; /** - * @ignore + * @hidden */ interface ExecuteArgs { retryContext?: RetryContext; @@ -23,7 +23,7 @@ interface ExecuteArgs { } /** - * @ignore + * @hidden */ interface RetryPolicies { endpointDiscoveryRetryPolicy: EndpointDiscoveryRetryPolicy; @@ -35,7 +35,7 @@ interface RetryPolicies { /** * * @param param0 - * @ignore + * @hidden */ export async function execute({ retryContext = {}, diff --git a/sdk/cosmosdb/cosmos/src/routing/CollectionRoutingMapFactory.ts b/sdk/cosmosdb/cosmos/src/routing/CollectionRoutingMapFactory.ts index 2e65846d7913..bf345ff74dba 100644 --- a/sdk/cosmosdb/cosmos/src/routing/CollectionRoutingMapFactory.ts +++ b/sdk/cosmosdb/cosmos/src/routing/CollectionRoutingMapFactory.ts @@ -4,7 +4,7 @@ import { Constants } from "../common/constants"; import { InMemoryCollectionRoutingMap } from "./inMemoryCollectionRoutingMap"; /** - * @ignore + * @hidden */ function compareRanges(a: any, b: any) { const aVal = a[0][Constants.PartitionKeyRange.MinInclusive]; @@ -43,7 +43,7 @@ export function createCompleteRoutingMap(partitionKeyRangeInfoTuppleList: any[]) } /** - * @ignore + * @hidden */ function isCompleteSetOfRange(partitionKeyOrderedRange: any) { // TODO: any diff --git a/sdk/cosmosdb/cosmos/src/routing/QueryRange.ts b/sdk/cosmosdb/cosmos/src/routing/QueryRange.ts index 6e0955ae981b..cc81d9644550 100644 --- a/sdk/cosmosdb/cosmos/src/routing/QueryRange.ts +++ b/sdk/cosmosdb/cosmos/src/routing/QueryRange.ts @@ -16,7 +16,7 @@ export class QueryRange { * @param {string} rangeMin - max * @param {boolean} isMinInclusive - isMinInclusive * @param {boolean} isMaxInclusive - isMaxInclusive - * @ignore + * @hidden */ constructor( rangeMin: string, @@ -67,7 +67,7 @@ export class QueryRange { /** * Parse a QueryRange from a partitionKeyRange * @returns QueryRange - * @ignore + * @hidden */ public static parsePartitionKeyRange(partitionKeyRange: any) { // TODO: paritionkeyrange @@ -81,7 +81,7 @@ export class QueryRange { /** * Parse a QueryRange from a dictionary * @returns QueryRange - * @ignore + * @hidden */ public static parseFromDict(queryRangeDict: any) { // TODO: queryRangeDictionary diff --git a/sdk/cosmosdb/cosmos/src/routing/partitionKeyRangeCache.ts b/sdk/cosmosdb/cosmos/src/routing/partitionKeyRangeCache.ts index f86c2fcd5f1e..756dd824a06f 100644 --- a/sdk/cosmosdb/cosmos/src/routing/partitionKeyRangeCache.ts +++ b/sdk/cosmosdb/cosmos/src/routing/partitionKeyRangeCache.ts @@ -18,7 +18,7 @@ export class PartitionKeyRangeCache { /** * Finds or Instantiates the requested Collection Routing Map * @param {string} collectionLink - Requested collectionLink - * @ignore + * @hidden */ public async onCollectionRoutingMap( collectionLink: string @@ -36,7 +36,7 @@ export class PartitionKeyRangeCache { * Given the query ranges and a collection, invokes the callback on the list of overlapping partition key ranges * @param collectionLink * @param queryRange - * @ignore + * @hidden */ public async getOverlappingRanges(collectionLink: string, queryRange: QueryRange) { const crm = await this.onCollectionRoutingMap(collectionLink); diff --git a/sdk/cosmosdb/cosmos/src/routing/smartRoutingMapProvider.ts b/sdk/cosmosdb/cosmos/src/routing/smartRoutingMapProvider.ts index c2045bebb1c1..7829b687f316 100644 --- a/sdk/cosmosdb/cosmos/src/routing/smartRoutingMapProvider.ts +++ b/sdk/cosmosdb/cosmos/src/routing/smartRoutingMapProvider.ts @@ -68,7 +68,7 @@ export class SmartRoutingMapProvider { * takes two parameters error, partition key ranges * @param collectionLink * @param sortedRanges - * @ignore + * @hidden */ public async getOverlappingRanges( collectionLink: string, diff --git a/sdk/cosmosdb/cosmos/src/session/SessionContext.ts b/sdk/cosmosdb/cosmos/src/session/SessionContext.ts index bfc0eda16b49..ddf9f8a52466 100644 --- a/sdk/cosmosdb/cosmos/src/session/SessionContext.ts +++ b/sdk/cosmosdb/cosmos/src/session/SessionContext.ts @@ -3,7 +3,7 @@ import { OperationType, ResourceType } from "../common"; /** - * @ignore + * @hidden */ export interface SessionContext { resourceId?: string; diff --git a/sdk/cosmosdb/cosmos/src/session/VectorSessionToken.ts b/sdk/cosmosdb/cosmos/src/session/VectorSessionToken.ts index 689469c19663..67761871c928 100644 --- a/sdk/cosmosdb/cosmos/src/session/VectorSessionToken.ts +++ b/sdk/cosmosdb/cosmos/src/session/VectorSessionToken.ts @@ -146,7 +146,7 @@ export class VectorSessionToken { } /** - * @ignore + * @hidden * @param int1 * @param int2 */ diff --git a/sdk/cosmosdb/cosmos/test/public/functional/item.spec.ts b/sdk/cosmosdb/cosmos/test/public/functional/item.spec.ts index 67863efddf2f..bf78c2ffeb69 100644 --- a/sdk/cosmosdb/cosmos/test/public/functional/item.spec.ts +++ b/sdk/cosmosdb/cosmos/test/public/functional/item.spec.ts @@ -19,7 +19,7 @@ import { import { BulkOperationType, OperationInput } from "../../../src"; /** - * @ignore + * @hidden * @hidden */ interface TestItem { diff --git a/sdk/cosmosdb/cosmos/tsdoc.json b/sdk/cosmosdb/cosmos/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/cosmosdb/cosmos/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/digitaltwins/digital-twins-core/src/digitalTwinsClient.ts b/sdk/digitaltwins/digital-twins-core/src/digitalTwinsClient.ts index b134ac3ccfc0..2879802ff1d1 100644 --- a/sdk/digitaltwins/digital-twins-core/src/digitalTwinsClient.ts +++ b/sdk/digitaltwins/digital-twins-core/src/digitalTwinsClient.ts @@ -73,7 +73,7 @@ const DEFAULT_DIGITALTWINS_SCOPE = "https://digitaltwins.azure.net/.default"; export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * A reference to the auto-generated AzureDigitalTwinsAPI */ private readonly client: GeneratedClient; @@ -436,7 +436,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the pagination of {@link listRelationships}. * * @param {PageSettings} continuationState An object that indicates the position of the paginated request. @@ -473,7 +473,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the iteration of all the available results of {@link listRelationships}. * @param {DigitalTwinsListRelationshipsOptionalParams} [options] Common options for the iterative endpoints. */ @@ -525,7 +525,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the pagination of {@link listIncomingRelationships}. * * @param {PageSettings} continuationState An object that indicates the position of the paginated request. @@ -562,7 +562,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the iteration of all the available results of {@link listIncomingRelationships}. * @param {OperationOptions} [options] Common options for the iterative endpoints. */ @@ -739,7 +739,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the pagination of {@link list}. * * @param {PageSettings} continuationState An object that indicates the position of the paginated request. @@ -771,7 +771,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the iteration of all the available results of {@link list}. * @param {DigitalTwinModelsListOptionalParams} [options] Common options for the iterative endpoints. */ @@ -943,7 +943,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the pagination of {@link list}. * * @param {PageSettings} continuationState An object that indicates the position of the paginated request. @@ -975,7 +975,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the iteration of all the available results of {@link list}. * @param {EventRoutesListOptionalParams} [options] Common options for the iterative endpoints. */ @@ -1100,7 +1100,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the pagination of {@link query}. * * @param {PageSettings} continuationState An object that indicates the position of the paginated request. @@ -1135,7 +1135,7 @@ export class DigitalTwinsClient { /** * @internal - * @ignore + * @hidden * Deals with the iteration of all the available results of {@link query}. * @param {OperationOptions} [options] Common options for the iterative endpoints. */ diff --git a/sdk/digitaltwins/digital-twins-core/src/tracing.ts b/sdk/digitaltwins/digital-twins-core/src/tracing.ts index bc8f9182cebd..907939ca1843 100644 --- a/sdk/digitaltwins/digital-twins-core/src/tracing.ts +++ b/sdk/digitaltwins/digital-twins-core/src/tracing.ts @@ -9,7 +9,7 @@ type OperationTracingOptions = OperationOptions["tracingOptions"]; /** * Creates a span using the global tracer. - * @ignore + * @hidden * @param name The name of the operation being performed. * @param tracingOptions The options for the underlying http request. */ diff --git a/sdk/digitaltwins/digital-twins-core/tsdoc.json b/sdk/digitaltwins/digital-twins-core/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/digitaltwins/digital-twins-core/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/digitaltwins/digital-twins/tsdoc.json b/sdk/digitaltwins/digital-twins/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/digitaltwins/digital-twins/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/eventhub/event-hubs/src/connectionContext.ts b/sdk/eventhub/event-hubs/src/connectionContext.ts index 7634c2db6b71..efe67cf368c6 100644 --- a/sdk/eventhub/event-hubs/src/connectionContext.ts +++ b/sdk/eventhub/event-hubs/src/connectionContext.ts @@ -25,7 +25,7 @@ import { SharedKeyCredential } from "./eventhubSharedKeyCredential"; /** * @internal - * @ignore + * @hidden * Provides contextual information like the underlying amqp connection, cbs session, management session, * tokenProvider, senders, receivers, etc. about the EventHub client. */ @@ -77,7 +77,7 @@ export interface ConnectionContext extends ConnectionContextBase { /** * Describes the members on the ConnectionContext that are only * used by it internally. - * @ignore + * @hidden * @internal */ export interface ConnectionContextInternalMembers extends ConnectionContext { @@ -101,7 +101,7 @@ export interface ConnectionContextInternalMembers extends ConnectionContext { /** * @internal - * @ignore + * @hidden */ export interface ConnectionContextOptions extends EventHubClientOptions { managementSessionAddress?: string; @@ -130,7 +130,7 @@ type ConnectionContextMethods = Omit< /** * @internal - * @ignore + * @hidden */ export namespace ConnectionContext { /** @@ -438,7 +438,7 @@ export namespace ConnectionContext { * Helper method to create a ConnectionContext from the input passed to either * EventHubProducerClient or EventHubConsumerClient constructors * - * @ignore + * @hidden * @internal */ export function createConnectionContext( diff --git a/sdk/eventhub/event-hubs/src/diagnostics/instrumentEventData.ts b/sdk/eventhub/event-hubs/src/diagnostics/instrumentEventData.ts index e6fd67991cbe..ca8b228b2719 100644 --- a/sdk/eventhub/event-hubs/src/diagnostics/instrumentEventData.ts +++ b/sdk/eventhub/event-hubs/src/diagnostics/instrumentEventData.ts @@ -6,7 +6,7 @@ import { Span, SpanContext } from "@opentelemetry/api"; import { EventData } from "../eventData"; /** - * @ignore + * @hidden */ export const TRACEPARENT_PROPERTY = "Diagnostic-Id"; @@ -16,7 +16,7 @@ export const TRACEPARENT_PROPERTY = "Diagnostic-Id"; * has already been instrumented. * @param eventData The `EventData` to instrument. * @param span The `Span` containing the context to propagate tracing information. - * @ignore + * @hidden * @internal */ export function instrumentEventData(eventData: EventData, span: Span): EventData { @@ -39,7 +39,7 @@ export function instrumentEventData(eventData: EventData, span: Span): EventData * Extracts the `SpanContext` from an `EventData` if the context exists. * @param eventData An individual `EventData` object. * @internal - * @ignore + * @hidden */ export function extractSpanContextFromEventData(eventData: EventData): SpanContext | undefined { if (!eventData.properties || !eventData.properties[TRACEPARENT_PROPERTY]) { diff --git a/sdk/eventhub/event-hubs/src/diagnostics/messageSpan.ts b/sdk/eventhub/event-hubs/src/diagnostics/messageSpan.ts index 5d858125ed9a..c1a90301758e 100644 --- a/sdk/eventhub/event-hubs/src/diagnostics/messageSpan.ts +++ b/sdk/eventhub/event-hubs/src/diagnostics/messageSpan.ts @@ -7,7 +7,7 @@ import { EventHubConnectionConfig } from "../eventhubConnectionConfig"; /** * @internal - * @ignore + * @hidden */ export function createMessageSpan( parentSpan?: Span | SpanContext | null, diff --git a/sdk/eventhub/event-hubs/src/eventData.ts b/sdk/eventhub/event-hubs/src/eventData.ts index d99e7bc7c496..4cc9f70f1aab 100644 --- a/sdk/eventhub/event-hubs/src/eventData.ts +++ b/sdk/eventhub/event-hubs/src/eventData.ts @@ -6,7 +6,7 @@ import { Constants } from "@azure/core-amqp"; /** * Describes the delivery annotations. - * @ignore + * @hidden */ export interface EventHubDeliveryAnnotations extends DeliveryAnnotations { /** @@ -33,7 +33,7 @@ export interface EventHubDeliveryAnnotations extends DeliveryAnnotations { /** * Map containing message attributes that will be held in the message header. - * @ignore + * @hidden */ export interface EventHubMessageAnnotations extends MessageAnnotations { /** @@ -60,7 +60,7 @@ export interface EventHubMessageAnnotations extends MessageAnnotations { /** * Describes the structure of an event to be sent or received from the EventHub. - * @ignore + * @hidden */ export interface EventDataInternal { /** @@ -129,7 +129,7 @@ const messagePropertiesMap = { /** * Converts the AMQP message to an EventData. * @param msg The AMQP message that needs to be converted to EventData. - * @ignore + * @hidden */ export function fromRheaMessage(msg: RheaMessage): EventDataInternal { const data: EventDataInternal = { @@ -191,7 +191,7 @@ export function fromRheaMessage(msg: RheaMessage): EventDataInternal { * Converts an EventData object to an AMQP message. * @param data The EventData object that needs to be converted to an AMQP message. * @param partitionKey An optional key to determine the partition that this event should land in. - * @ignore + * @hidden */ export function toRheaMessage(data: EventData, partitionKey?: string): RheaMessage { const msg: RheaMessage = { diff --git a/sdk/eventhub/event-hubs/src/eventDataBatch.ts b/sdk/eventhub/event-hubs/src/eventDataBatch.ts index 65c6373a4431..8734378ab30f 100644 --- a/sdk/eventhub/event-hubs/src/eventDataBatch.ts +++ b/sdk/eventhub/event-hubs/src/eventDataBatch.ts @@ -27,7 +27,7 @@ const smallMessageMaxBytes = 255; * Checks if the provided eventDataBatch is an instance of `EventDataBatch`. * @param eventDataBatch The instance of `EventDataBatch` to verify. * @internal - * @ignore + * @hidden */ export function isEventDataBatch(eventDataBatch: any): eventDataBatch is EventDataBatch { return ( @@ -63,7 +63,7 @@ export interface EventDataBatch { * set the partitionKey. * @readonly * @internal - * @ignore + * @hidden */ readonly partitionKey?: string; @@ -72,7 +72,7 @@ export interface EventDataBatch { * the `EventHubProducerClient` to set the partitionId. * @readonly * @internal - * @ignore + * @hidden */ readonly partitionId?: string; @@ -113,7 +113,7 @@ export interface EventDataBatch { * This is not meant for the user to use directly. * * @internal - * @ignore + * @hidden */ _generateMessage(): Buffer; @@ -121,7 +121,7 @@ export interface EventDataBatch { * Gets the "message" span contexts that were created when adding events to the batch. * Used internally by the `sendBatch()` method to set up the right spans in traces if tracing is enabled. * @internal - * @ignore + * @hidden */ readonly _messageSpanContexts: SpanContext[]; } @@ -131,7 +131,7 @@ export interface EventDataBatch { * * @class * @internal - * @ignore + * @hidden */ export class EventDataBatchImpl implements EventDataBatch { /** @@ -182,7 +182,7 @@ export class EventDataBatchImpl implements EventDataBatch { * Use the `createBatch()` method on your `EventHubProducer` instead. * @constructor * @internal - * @ignore + * @hidden */ constructor( context: ConnectionContext, @@ -244,7 +244,7 @@ export class EventDataBatchImpl implements EventDataBatch { /** * Gets the "message" span contexts that were created when adding events to the batch. * @internal - * @ignore + * @hidden */ get _messageSpanContexts(): SpanContext[] { return this._spanContexts; diff --git a/sdk/eventhub/event-hubs/src/eventHubConsumerClient.ts b/sdk/eventhub/event-hubs/src/eventHubConsumerClient.ts index dffdade456ff..93b1b90112f0 100644 --- a/sdk/eventhub/event-hubs/src/eventHubConsumerClient.ts +++ b/sdk/eventhub/event-hubs/src/eventHubConsumerClient.ts @@ -620,7 +620,7 @@ export class EventHubConsumerClient { /** * @internal - * @ignore + * @hidden */ export function isCheckpointStore(possible: CheckpointStore | any): possible is CheckpointStore { if (!possible) { @@ -639,7 +639,7 @@ export function isCheckpointStore(possible: CheckpointStore | any): possible is /** * @internal - * @ignore + * @hidden */ function isSubscriptionEventHandlers( possible: any | SubscriptionEventHandlers diff --git a/sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts b/sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts index 93413b5a8d08..ca3c172fdd61 100644 --- a/sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts +++ b/sdk/eventhub/event-hubs/src/eventHubConsumerClientModels.ts @@ -10,7 +10,7 @@ import { MessagingError } from "@azure/core-amqp"; /** * @internal - * @ignore + * @hidden */ export interface BasicPartitionProperties { /** @@ -209,10 +209,10 @@ export interface SubscribeOptions { export interface Subscription { /** * Stops the subscription from receiving more messages. - * + * * If a checkpoint store has been configured this will also mark this subscription's * partitions as abandoned, freeing them up to be read by other consumers. - * + * * @returns Promise * @throws Error if the underlying connection encounters an error while closing. */ diff --git a/sdk/eventhub/event-hubs/src/eventHubReceiver.ts b/sdk/eventhub/event-hubs/src/eventHubReceiver.ts index 185bdb200707..51c5b4b9d9fb 100644 --- a/sdk/eventhub/event-hubs/src/eventHubReceiver.ts +++ b/sdk/eventhub/event-hubs/src/eventHubReceiver.ts @@ -28,7 +28,7 @@ import { AbortError, AbortSignalLike } from "@azure/abort-controller"; import { defaultDataTransformer } from "./dataTransformer"; /** - * @ignore + * @hidden */ interface CreateReceiverOptions { onMessage: OnAmqpEvent; @@ -69,21 +69,21 @@ export interface LastEnqueuedEventProperties { /** * Describes the message handler signature. * @internal - * @ignore + * @hidden */ export type OnMessage = (eventData: ReceivedEventData) => void; /** * Describes the error handler signature. * @internal - * @ignore + * @hidden */ export type OnError = (error: MessagingError | Error) => void; /** * Describes the abort handler signature. * @internal - * @ignore + * @hidden */ export type OnAbort = () => void; @@ -91,7 +91,7 @@ export type OnAbort = () => void; * Describes the EventHubReceiver that will receive event data from EventHub. * @class EventHubReceiver * @internal - * @ignore + * @hidden */ export class EventHubReceiver extends LinkEntity { /** @@ -196,7 +196,7 @@ export class EventHubReceiver extends LinkEntity { /** * Instantiates a receiver that can be used to receive events over an AMQP receiver link in * either batching or streaming mode. - * @ignore + * @hidden * @constructor * @param context The connection context corresponding to the EventHubClient instance * @param consumerGroup The consumer group from which the receiver should receive events from. @@ -365,7 +365,7 @@ export class EventHubReceiver extends LinkEntity { /** * Clears the user-provided handlers and updates the receiving messages flag. - * @ignore + * @hidden */ clearHandlers(): void { if (this._abortSignal && this._onAbort) { @@ -382,7 +382,7 @@ export class EventHubReceiver extends LinkEntity { /** * Closes the underlying AMQP receiver. - * @ignore + * @hidden */ async close(): Promise { try { @@ -407,7 +407,7 @@ export class EventHubReceiver extends LinkEntity { /** * Determines whether the AMQP receiver link is open. If open then returns true else returns false. - * @ignore + * @hidden * @returns boolean */ isOpen(): boolean { @@ -425,7 +425,7 @@ export class EventHubReceiver extends LinkEntity { /** * Registers the user's onMessage and onError handlers. * Sends buffered events from the queue before adding additional credits to the AMQP link. - * @ignore + * @hidden */ registerHandlers( onMessage: OnMessage, @@ -540,7 +540,7 @@ export class EventHubReceiver extends LinkEntity { /** * Creates a new AMQP receiver under a new AMQP session. - * @ignore + * @hidden */ async initialize(): Promise { try { @@ -608,7 +608,7 @@ export class EventHubReceiver extends LinkEntity { /** * Creates the options that need to be specified while creating an AMQP receiver link. - * @ignore + * @hidden */ private _createReceiverOptions(options: CreateReceiverOptions): RheaReceiverOptions { if (options.newName) this.name = uuid(); diff --git a/sdk/eventhub/event-hubs/src/eventHubSender.ts b/sdk/eventhub/event-hubs/src/eventHubSender.ts index e6dd5c5b55ec..cbbaaefadec9 100644 --- a/sdk/eventhub/event-hubs/src/eventHubSender.ts +++ b/sdk/eventhub/event-hubs/src/eventHubSender.ts @@ -37,7 +37,7 @@ import { defaultDataTransformer } from "./dataTransformer"; * Describes the EventHubSender that will send event data to EventHub. * @class EventHubSender * @internal - * @ignore + * @hidden */ export class EventHubSender extends LinkEntity { /** @@ -75,7 +75,7 @@ export class EventHubSender extends LinkEntity { /** * Creates a new EventHubSender instance. - * @ignore + * @hidden * @constructor * @param context The connection context. * @param [partitionId] The EventHub partition id to which the sender @@ -168,7 +168,7 @@ export class EventHubSender extends LinkEntity { /** * Deletes the sender from the context. Clears the token renewal timer. Closes the sender link. - * @ignore + * @hidden * @returns Promise */ async close(): Promise { @@ -193,7 +193,7 @@ export class EventHubSender extends LinkEntity { /** * Determines whether the AMQP sender link is open. If open then returns true else returns false. - * @ignore + * @hidden * @returns boolean */ isOpen(): boolean { @@ -288,7 +288,7 @@ export class EventHubSender extends LinkEntity { * Send a batch of EventData to the EventHub. The "message_annotations", * "application_properties" and "properties" of the first message will be set as that * of the envelope (batch message). - * @ignore + * @hidden * @param events An array of EventData objects to be sent in a Batch message. * @param options Options to control the way the events are batched along with request options * @return Promise @@ -390,7 +390,7 @@ export class EventHubSender extends LinkEntity { * * We have implemented a synchronous send over here in the sense that we shall be waiting * for the message to be accepted or rejected and accordingly resolve or reject the promise. - * @ignore + * @hidden * @param message The message to be sent to EventHub. * @returns Promise */ @@ -542,7 +542,7 @@ export class EventHubSender extends LinkEntity { /** * Initializes the sender session on the connection. - * @ignore + * @hidden */ private async _init(options: AwaitableSenderOptions): Promise { try { @@ -601,7 +601,7 @@ export class EventHubSender extends LinkEntity { /** * Creates a new sender to the given event hub, and optionally to a given partition if it is * not present in the context or returns the one present in the context. - * @ignore + * @hidden * @static * @param [partitionId] Partition ID to which it will send event data. */ diff --git a/sdk/eventhub/event-hubs/src/eventPosition.ts b/sdk/eventhub/event-hubs/src/eventPosition.ts index 08b6fb376896..201bc3f621e6 100644 --- a/sdk/eventhub/event-hubs/src/eventPosition.ts +++ b/sdk/eventhub/event-hubs/src/eventPosition.ts @@ -44,7 +44,7 @@ export interface EventPosition { /** * @internal - * @ignore + * @hidden * Gets the expression to be set as the filter clause when creating the receiver * @return {string} filterExpression */ @@ -78,7 +78,7 @@ export function getEventPositionFilter(eventPosition: EventPosition): string { /** * @internal - * @ignore + * @hidden */ export function isLatestPosition(eventPosition: EventPosition): boolean { if (eventPosition.offset === "@latest") { @@ -108,7 +108,7 @@ export const latestEventPosition: EventPosition = { }; /** - * @ignore + * @hidden * @internal */ export function validateEventPositions( @@ -143,7 +143,7 @@ export function validateEventPositions( * Determines whether a position is an EventPosition. * Does not validate that the position is allowed. * @param position - * @ignore + * @hidden * @internal */ export function isEventPosition(position: any): position is EventPosition { diff --git a/sdk/eventhub/event-hubs/src/eventProcessor.ts b/sdk/eventhub/event-hubs/src/eventProcessor.ts index e578f06fb15c..cb51278f0b9c 100644 --- a/sdk/eventhub/event-hubs/src/eventProcessor.ts +++ b/sdk/eventhub/event-hubs/src/eventProcessor.ts @@ -126,13 +126,13 @@ export interface CheckpointStore { * } * ``` * @internal - * @ignore + * @hidden */ export interface FullEventProcessorOptions extends CommonEventProcessorOptions { /** * An optional pump manager to use, rather than instantiating one internally * @internal - * @ignore + * @hidden */ pumpManager?: PumpManager; /** @@ -175,7 +175,7 @@ export interface FullEventProcessorOptions extends CommonEventProcessorOptions { * * @class EventProcessor * @internal - * @ignore + * @hidden */ export class EventProcessor { private _processorOptions: FullEventProcessorOptions; diff --git a/sdk/eventhub/event-hubs/src/eventhubSharedKeyCredential.ts b/sdk/eventhub/event-hubs/src/eventhubSharedKeyCredential.ts index fe7c1f9deb81..7e0d0d0cf0bb 100644 --- a/sdk/eventhub/event-hubs/src/eventhubSharedKeyCredential.ts +++ b/sdk/eventhub/event-hubs/src/eventhubSharedKeyCredential.ts @@ -97,7 +97,7 @@ export class SharedKeyCredential { * `SharedAccessSignature sr=&sig=&se=&skn=` * * @internal - * @ignore + * @hidden */ export class SharedAccessSignatureCredential extends SharedKeyCredential { private _accessToken: AccessToken; diff --git a/sdk/eventhub/event-hubs/src/impl/partitionGate.ts b/sdk/eventhub/event-hubs/src/impl/partitionGate.ts index 1b45e8852e00..e5f59173971b 100644 --- a/sdk/eventhub/event-hubs/src/impl/partitionGate.ts +++ b/sdk/eventhub/event-hubs/src/impl/partitionGate.ts @@ -10,7 +10,7 @@ * continually steals/overwrites checkpointing and ownership with itself. * * @internal - * @ignore + * @hidden */ export class PartitionGate { private _partitions = new Set(); diff --git a/sdk/eventhub/event-hubs/src/inMemoryCheckpointStore.ts b/sdk/eventhub/event-hubs/src/inMemoryCheckpointStore.ts index af72368ba776..1bc75b4fa48a 100644 --- a/sdk/eventhub/event-hubs/src/inMemoryCheckpointStore.ts +++ b/sdk/eventhub/event-hubs/src/inMemoryCheckpointStore.ts @@ -17,7 +17,7 @@ import { throwTypeErrorIfParameterMissing } from "./util/error"; * * @class * @internal - * @ignore + * @hidden */ export class InMemoryCheckpointStore implements CheckpointStore { private _partitionOwnershipMap: Map = new Map(); diff --git a/sdk/eventhub/event-hubs/src/linkEntity.ts b/sdk/eventhub/event-hubs/src/linkEntity.ts index a32f10fd9b9e..f41395637c3c 100644 --- a/sdk/eventhub/event-hubs/src/linkEntity.ts +++ b/sdk/eventhub/event-hubs/src/linkEntity.ts @@ -10,7 +10,7 @@ import { logger } from "./log"; import { SharedKeyCredential } from "../src/eventhubSharedKeyCredential"; /** - * @ignore + * @hidden */ export interface LinkEntityOptions { /** @@ -35,7 +35,7 @@ export interface LinkEntityOptions { /** * Describes the base class for entities like EventHub Sender, Receiver and Management link. * @internal - * @ignore + * @hidden * @class LinkEntity */ export class LinkEntity { @@ -96,7 +96,7 @@ export class LinkEntity { protected _tokenTimeoutInMs?: number; /** * Creates a new LinkEntity instance. - * @ignore + * @hidden * @constructor * @param context The connection context. * @param [options] Options that can be provided while creating the LinkEntity. @@ -112,7 +112,7 @@ export class LinkEntity { /** * Negotiates cbs claim for the LinkEntity. - * @ignore + * @hidden * @param [setTokenRenewal] Set the token renewal timer. Default false. * @returns Promise */ @@ -187,7 +187,7 @@ export class LinkEntity { /** * Ensures that the token is renewed within the predefined renewal margin. - * @ignore + * @hidden */ protected async _ensureTokenRenewal(): Promise { if (!this._tokenTimeoutInMs) { @@ -227,7 +227,7 @@ export class LinkEntity { /** * Closes the Sender|Receiver link and it's underlying session and also removes it from the * internal map. - * @ignore + * @hidden * @param [link] The Sender or Receiver link that needs to be closed and * removed. */ diff --git a/sdk/eventhub/event-hubs/src/loadBalancerStrategies/balancedStrategy.ts b/sdk/eventhub/event-hubs/src/loadBalancerStrategies/balancedStrategy.ts index fe3212a2c07e..1fcea6d53ea4 100644 --- a/sdk/eventhub/event-hubs/src/loadBalancerStrategies/balancedStrategy.ts +++ b/sdk/eventhub/event-hubs/src/loadBalancerStrategies/balancedStrategy.ts @@ -12,7 +12,7 @@ import { LoadBalancingStrategy, listAvailablePartitions } from "./loadBalancingS * by only returning a single partition to claim at a time. * This minimizes the number of times a partition should need to be stolen. * @internal - * @ignore + * @hidden */ export class BalancedLoadBalancingStrategy implements LoadBalancingStrategy { /** diff --git a/sdk/eventhub/event-hubs/src/loadBalancerStrategies/greedyStrategy.ts b/sdk/eventhub/event-hubs/src/loadBalancerStrategies/greedyStrategy.ts index 77b6604e99a7..b87dcd498519 100644 --- a/sdk/eventhub/event-hubs/src/loadBalancerStrategies/greedyStrategy.ts +++ b/sdk/eventhub/event-hubs/src/loadBalancerStrategies/greedyStrategy.ts @@ -6,7 +6,7 @@ import { LoadBalancingStrategy, listAvailablePartitions } from "./loadBalancingS /** * @internal - * @ignore + * @hidden */ export class GreedyLoadBalancingStrategy implements LoadBalancingStrategy { /** diff --git a/sdk/eventhub/event-hubs/src/loadBalancerStrategies/loadBalancingStrategy.ts b/sdk/eventhub/event-hubs/src/loadBalancerStrategies/loadBalancingStrategy.ts index 1aa0de11dc81..de78a2efd62b 100644 --- a/sdk/eventhub/event-hubs/src/loadBalancerStrategies/loadBalancingStrategy.ts +++ b/sdk/eventhub/event-hubs/src/loadBalancerStrategies/loadBalancingStrategy.ts @@ -7,7 +7,7 @@ import { logger } from "../log"; /** * Determines which partitions to claim as part of load balancing. * @internal - * @ignore + * @hidden */ export interface LoadBalancingStrategy { /** @@ -28,7 +28,7 @@ export interface LoadBalancingStrategy { /** * Counts of the EventProcessors that currently own partitions. * @internal - * @ignore + * @hidden */ interface EventProcessorCounts { /** @@ -60,7 +60,7 @@ interface EventProcessorCounts { * * @param partitionOwnershipMap The existing PartitionOwnerships mapped by partition. * @param expirationIntervalInMs The length of time a PartitionOwnership claim is valid. - * @ignore + * @hidden * @internal */ function getActivePartitionOwnerships( @@ -91,7 +91,7 @@ function getActivePartitionOwnerships( * and the number of EventProcessors that should have an extra partition assigned. * @param ownerToOwnershipMap The current ownerships for partitions. * @param partitionIds The full list of the Event Hub's partition ids. - * @ignore + * @hidden * @internal */ function calculateBalancedLoadCounts( @@ -131,7 +131,7 @@ function calculateBalancedLoadCounts( * @param minPartitionsPerOwner The number of required partitions per EventProcessor. * @param ownerToOwnershipMap The current ownerships for partitions. * @internal - * @ignore + * @hidden */ function getEventProcessorCounts( minPartitionsPerOwner: number, @@ -174,7 +174,7 @@ function getEventProcessorCounts( * @param requiredNumberOfOwnersWithExtraPartition The # of EventProcessors that process an additional partition, in addition to the required minimum. * @param totalExpectedProcessors The total # of EventProcessors we expect. * @param eventProcessorCounts EventProcessor counts, grouped by criteria. - * @ignore + * @hidden * @internal */ function isLoadBalanced( @@ -195,7 +195,7 @@ function isLoadBalanced( * @param requiredNumberOfOwnersWithExtraPartition The current number of processors that should have an additional partition. * @param numPartitionsOwnedByUs The number of partitions we currently own. * @param eventProcessorCounts Processors, grouped by criteria. - * @ignore + * @hidden * @internal */ function getNumberOfPartitionsToClaim( @@ -229,7 +229,7 @@ function getNumberOfPartitionsToClaim( * @param ourOwnerId The id of _our_ owner. * @param ownerToOwnershipMap The current ownerships for partitions. * @internal - * @ignore + * @hidden */ function findPartitionsToSteal( numberOfPartitionsToClaim: number, @@ -291,7 +291,7 @@ function findPartitionsToSteal( * @param expirationIntervalInMs The length of time a partition claim is valid. * @returns Partition ids that may be claimed. * @internal - * @ignore + * @hidden */ export function listAvailablePartitions( ownerId: string, diff --git a/sdk/eventhub/event-hubs/src/loadBalancerStrategies/unbalancedStrategy.ts b/sdk/eventhub/event-hubs/src/loadBalancerStrategies/unbalancedStrategy.ts index 549b7970bb8e..b66db1ebb53b 100644 --- a/sdk/eventhub/event-hubs/src/loadBalancerStrategies/unbalancedStrategy.ts +++ b/sdk/eventhub/event-hubs/src/loadBalancerStrategies/unbalancedStrategy.ts @@ -9,7 +9,7 @@ import { LoadBalancingStrategy } from "./loadBalancingStrategy"; * It is intended to be used when you want to avoid load balancing * and consume a set of partitions. * @internal - * @ignore + * @hidden */ export class UnbalancedLoadBalancingStrategy implements LoadBalancingStrategy { /** diff --git a/sdk/eventhub/event-hubs/src/log.ts b/sdk/eventhub/event-hubs/src/log.ts index 7f0b79fc4950..587f23af9ddb 100644 --- a/sdk/eventhub/event-hubs/src/log.ts +++ b/sdk/eventhub/event-hubs/src/log.ts @@ -12,7 +12,7 @@ export const logger = createClientLogger("event-hubs"); /** * Logs the error's stack trace to "verbose" if a stack trace is available. * @param error Error containing a stack trace. - * @ignore + * @hidden */ export function logErrorStackTrace(error: any) { if (error && error.stack) { diff --git a/sdk/eventhub/event-hubs/src/managementClient.ts b/sdk/eventhub/event-hubs/src/managementClient.ts index 0716658d8568..824fa18cb4fa 100644 --- a/sdk/eventhub/event-hubs/src/managementClient.ts +++ b/sdk/eventhub/event-hubs/src/managementClient.ts @@ -88,7 +88,7 @@ export interface PartitionProperties { /** * @internal - * @ignore + * @hidden */ export interface ManagementClientOptions { address?: string; @@ -98,7 +98,7 @@ export interface ManagementClientOptions { /** * @class ManagementClient * @internal - * @ignore + * @hidden * Descibes the EventHubs Management Client that talks * to the $management endpoint over AMQP connection. */ @@ -121,7 +121,7 @@ export class ManagementClient extends LinkEntity { /** * Instantiates the management client. * @constructor - * @ignore + * @hidden * @param context The connection context. * @param [address] The address for the management endpoint. For IotHub it will be * `/messages/events/$management`. @@ -138,7 +138,7 @@ export class ManagementClient extends LinkEntity { /** * Gets the security token for the management application properties. - * @ignore + * @hidden * @internal */ async getSecurityToken() { @@ -160,7 +160,7 @@ export class ManagementClient extends LinkEntity { /** * Provides the eventhub runtime information. - * @ignore + * @hidden */ async getEventHubProperties( options: OperationOptions & { retryOptions?: RetryOptions } = {} @@ -214,7 +214,7 @@ export class ManagementClient extends LinkEntity { /** * Provides information about the specified partition. - * @ignore + * @hidden * @param partitionId Partition ID for which partition information is required. */ async getPartitionProperties( @@ -287,7 +287,7 @@ export class ManagementClient extends LinkEntity { /** * Closes the AMQP management session to the Event Hub for this client, * returning a promise that will be resolved when disconnection is completed. - * @ignore + * @hidden */ async close(): Promise { try { diff --git a/sdk/eventhub/event-hubs/src/models/private.ts b/sdk/eventhub/event-hubs/src/models/private.ts index a5464e88ddb7..f08e57ad246c 100644 --- a/sdk/eventhub/event-hubs/src/models/private.ts +++ b/sdk/eventhub/event-hubs/src/models/private.ts @@ -11,7 +11,7 @@ import { LoadBalancingStrategy } from "../loadBalancerStrategies/loadBalancingSt * - `partitionId` : The string identifier of the partition that the producer can be bound to. * - `retryOptions` : The retry options used to govern retry attempts when an issue is encountered while sending events. * A simple usage can be `{ "maxRetries": 4 }`. - * @ignore + * @hidden * @internal */ export interface EventHubProducerOptions { @@ -32,13 +32,13 @@ export interface EventHubProducerOptions { /** * @internal - * @ignore + * @hidden */ export type OperationNames = "getEventHubProperties" | "getPartitionIds" | "getPartitionProperties"; /** * @internal - * @ignore + * @hidden */ export interface CommonEventProcessorOptions extends Required>, @@ -92,7 +92,7 @@ export interface CommonEventProcessorOptions * } * ``` * @internal - * @ignore + * @hidden */ export interface EventHubConsumerOptions { /** diff --git a/sdk/eventhub/event-hubs/src/models/public.ts b/sdk/eventhub/event-hubs/src/models/public.ts index 13095301d343..fdfa198af89c 100644 --- a/sdk/eventhub/event-hubs/src/models/public.ts +++ b/sdk/eventhub/event-hubs/src/models/public.ts @@ -61,7 +61,7 @@ export interface SendBatchOptions extends OperationOptions { * ``` * * @internal - * @ignore + * @hidden */ export interface SendOptions extends OperationOptions { /** diff --git a/sdk/eventhub/event-hubs/src/partitionProcessor.ts b/sdk/eventhub/event-hubs/src/partitionProcessor.ts index 9060aa4d44c0..62b1614c7014 100644 --- a/sdk/eventhub/event-hubs/src/partitionProcessor.ts +++ b/sdk/eventhub/event-hubs/src/partitionProcessor.ts @@ -60,7 +60,7 @@ export interface Checkpoint { * - Optionally override the `initialize()` method to implement any set up related tasks you would want to carry out before starting to receive events from the partition * - Optionally override the `close()` method to implement any tear down or clean up tasks you would want to carry out. * @internal - * @ignore + * @hidden */ export class PartitionProcessor implements PartitionContext { private _lastEnqueuedEventProperties?: LastEnqueuedEventProperties; diff --git a/sdk/eventhub/event-hubs/src/partitionPump.ts b/sdk/eventhub/event-hubs/src/partitionPump.ts index cf3c69fa126e..95b1e2872cde 100644 --- a/sdk/eventhub/event-hubs/src/partitionPump.ts +++ b/sdk/eventhub/event-hubs/src/partitionPump.ts @@ -17,7 +17,7 @@ import { ReceivedEventData } from "./eventData"; import { ConnectionContext } from "./connectionContext"; /** - * @ignore + * @hidden * @internal */ export class PartitionPump { @@ -209,7 +209,7 @@ export class PartitionPump { /** * @internal - * @ignore + * @hidden */ export function createProcessingSpan( receivedEvents: ReceivedEventData[], @@ -249,7 +249,7 @@ export function createProcessingSpan( } /** - * @ignore + * @hidden * @internal */ export async function trace(fn: () => Promise, span: Span): Promise { diff --git a/sdk/eventhub/event-hubs/src/pumpManager.ts b/sdk/eventhub/event-hubs/src/pumpManager.ts index 1471e4a435b4..965163a4ea0a 100644 --- a/sdk/eventhub/event-hubs/src/pumpManager.ts +++ b/sdk/eventhub/event-hubs/src/pumpManager.ts @@ -14,7 +14,7 @@ import { ConnectionContext } from "./connectionContext"; * The PumpManager handles the creation and removal of PartitionPumps. * It also starts a PartitionPump when it is created, and stops a * PartitionPump when it is removed. - * @ignore + * @hidden * @internal */ export interface PumpManager { @@ -24,7 +24,7 @@ export interface PumpManager { * @param eventHubClient The EventHubClient to forward to the PartitionPump. * @param partitionProcessor The PartitionProcessor to forward to the PartitionPump. * @param abortSignal Used to cancel pump creation. - * @ignore + * @hidden */ createPump( startPosition: EventPosition, @@ -36,7 +36,7 @@ export interface PumpManager { /** * Indicates whether the pump manager is actively receiving events from a given partition. * @param partitionId The partition to check. - * @ignore + * @hidden * @internal */ isReceivingFromPartition(partitionId: string): boolean; @@ -44,7 +44,7 @@ export interface PumpManager { /** * Stops all PartitionPumps and removes them from the internal map. * @param reason The reason for removing the pump. - * @ignore + * @hidden */ removeAllPumps(reason: CloseReason): Promise; } @@ -53,7 +53,7 @@ export interface PumpManager { * The PumpManager handles the creation and removal of PartitionPumps. * It also starts a PartitionPump when it is created, and stops a * PartitionPump when it is removed. - * @ignore + * @hidden * @internal */ export class PumpManagerImpl implements PumpManager { @@ -64,7 +64,7 @@ export class PumpManagerImpl implements PumpManager { } = {}; /** - * @ignore + * @hidden */ constructor(eventProcessorName: string, eventProcessorOptions: CommonEventProcessorOptions) { this._eventProcessorName = eventProcessorName; @@ -73,7 +73,7 @@ export class PumpManagerImpl implements PumpManager { /** * Returns a list of partitionIds that are actively receiving messages. - * @ignore + * @hidden */ public receivingFromPartitions(): string[] { return Object.keys(this._partitionIdToPumps).filter((id) => { @@ -85,7 +85,7 @@ export class PumpManagerImpl implements PumpManager { /** * Indicates whether the pump manager is actively receiving events from a given partition. * @param partitionId - * @ignore + * @hidden * @internal */ public isReceivingFromPartition(partitionId: string): boolean { @@ -98,7 +98,7 @@ export class PumpManagerImpl implements PumpManager { * @param startPosition The position in the partition to start reading from. * @param connectionContext The ConnectionContext to forward to the PartitionPump. * @param partitionProcessor The PartitionProcessor to forward to the PartitionPump. - * @ignore + * @hidden */ public async createPump( startPosition: EventPosition, @@ -154,7 +154,7 @@ export class PumpManagerImpl implements PumpManager { * Stop a PartitionPump and removes it from the internal map. * @param partitionId The partitionId to remove the associated PartitionPump from. * @param reason The reason for removing the pump. - * @ignore + * @hidden */ public async removePump(partitionId: string, reason: CloseReason): Promise { try { @@ -179,7 +179,7 @@ export class PumpManagerImpl implements PumpManager { /** * Stops all PartitionPumps and removes them from the internal map. * @param reason The reason for removing the pump. - * @ignore + * @hidden */ public async removeAllPumps(reason: CloseReason): Promise { const partitionIds = Object.keys(this._partitionIdToPumps); diff --git a/sdk/eventhub/event-hubs/src/receiveHandler.ts b/sdk/eventhub/event-hubs/src/receiveHandler.ts index 31eaf8a921e9..f54e3b2d9d03 100644 --- a/sdk/eventhub/event-hubs/src/receiveHandler.ts +++ b/sdk/eventhub/event-hubs/src/receiveHandler.ts @@ -8,7 +8,7 @@ import { logErrorStackTrace, logger } from "./log"; * Describes the receive handler object that is returned from the receive() method with handlers. * The ReceiveHandler is used to stop receiving more messages. * @class ReceiveHandler - * @ignore + * @hidden * @internal */ export class ReceiveHandler { diff --git a/sdk/eventhub/event-hubs/src/util/constants.ts b/sdk/eventhub/event-hubs/src/util/constants.ts index 6904024e1549..507615cb1a15 100644 --- a/sdk/eventhub/event-hubs/src/util/constants.ts +++ b/sdk/eventhub/event-hubs/src/util/constants.ts @@ -2,7 +2,7 @@ // Licensed under the MIT license. /** - * @ignore + * @hidden */ export const packageJsonInfo = { name: "@azure/event-hubs", diff --git a/sdk/eventhub/event-hubs/src/util/delayWithoutThrow.ts b/sdk/eventhub/event-hubs/src/util/delayWithoutThrow.ts index 1165915b8159..0b4dfcc4e6e9 100644 --- a/sdk/eventhub/event-hubs/src/util/delayWithoutThrow.ts +++ b/sdk/eventhub/event-hubs/src/util/delayWithoutThrow.ts @@ -8,7 +8,7 @@ import { AbortSignalLike } from "@azure/abort-controller"; * @param delayInMs The number of milliseconds to be delayed. * @param abortSignal The abortSignal associated with the containing operation. * @internal - * @ignore + * @hidden */ export async function delayWithoutThrow( delayInMs: number, diff --git a/sdk/eventhub/event-hubs/src/util/error.ts b/sdk/eventhub/event-hubs/src/util/error.ts index 4312093527f0..83ef87678e8a 100644 --- a/sdk/eventhub/event-hubs/src/util/error.ts +++ b/sdk/eventhub/event-hubs/src/util/error.ts @@ -6,7 +6,7 @@ import { ConnectionContext } from "../connectionContext"; /** * @internal - * @ignore + * @hidden * Logs and throws Error if the current AMQP connection is closed. * @param context The ConnectionContext associated with the current AMQP connection. */ @@ -22,7 +22,7 @@ export function throwErrorIfConnectionClosed(context: ConnectionContext): void { /** * @internal - * @ignore + * @hidden * Logs and Throws TypeError if given parameter is undefined or null * @param connectionId Id of the underlying AMQP connection used for logging * @param methodName Name of the method that was passed the parameter diff --git a/sdk/eventhub/event-hubs/src/util/operationOptions.ts b/sdk/eventhub/event-hubs/src/util/operationOptions.ts index 44531e3287e5..46252c54ad46 100644 --- a/sdk/eventhub/event-hubs/src/util/operationOptions.ts +++ b/sdk/eventhub/event-hubs/src/util/operationOptions.ts @@ -23,7 +23,7 @@ export interface OperationOptions { /** * @internal - * @ignore + * @hidden */ export function getParentSpan( options?: OperationTracingOptions diff --git a/sdk/eventhub/event-hubs/src/util/retries.ts b/sdk/eventhub/event-hubs/src/util/retries.ts index 5d055bed4737..e4d69b513f5e 100644 --- a/sdk/eventhub/event-hubs/src/util/retries.ts +++ b/sdk/eventhub/event-hubs/src/util/retries.ts @@ -5,7 +5,7 @@ import { Constants, RetryOptions } from "@azure/core-amqp"; /** * @internal - * @ignore + * @hidden */ export function getRetryAttemptTimeoutInMs(retryOptions: RetryOptions | undefined): number { const timeoutInMs = diff --git a/sdk/eventhub/event-hubs/src/util/runtimeInfo.browser.ts b/sdk/eventhub/event-hubs/src/util/runtimeInfo.browser.ts index e0b67985181c..8bf8ff00c379 100644 --- a/sdk/eventhub/event-hubs/src/util/runtimeInfo.browser.ts +++ b/sdk/eventhub/event-hubs/src/util/runtimeInfo.browser.ts @@ -13,7 +13,7 @@ interface Navigator { /** * Returns information about the platform this function is being run on. - * @ignore + * @hidden * @internal */ export function getRuntimeInfo(): string { diff --git a/sdk/eventhub/event-hubs/src/util/runtimeInfo.ts b/sdk/eventhub/event-hubs/src/util/runtimeInfo.ts index cf7afd5ff5a9..ac1efee65d0b 100644 --- a/sdk/eventhub/event-hubs/src/util/runtimeInfo.ts +++ b/sdk/eventhub/event-hubs/src/util/runtimeInfo.ts @@ -5,7 +5,7 @@ import * as os from "os"; /** * Returns information about the platform this function is being run on. - * @ignore + * @hidden * @internal */ export function getRuntimeInfo(): string { diff --git a/sdk/eventhub/event-hubs/tsdoc.json b/sdk/eventhub/event-hubs/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/eventhub/event-hubs/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/eventhub/event-processor-host/src/azureBlob.ts b/sdk/eventhub/event-processor-host/src/azureBlob.ts index 3cf62dec121b..aca4357d09c7 100644 --- a/sdk/eventhub/event-processor-host/src/azureBlob.ts +++ b/sdk/eventhub/event-processor-host/src/azureBlob.ts @@ -6,7 +6,7 @@ import { BlobService as StorageBlobService } from "azure-storage"; import { Dictionary } from "@azure/event-hubs"; /** - * @ignore + * @hidden */ export class AzureBlob { private _blobService: BlobService; diff --git a/sdk/eventhub/event-processor-host/src/azureStorageCheckpointLeaseManager.ts b/sdk/eventhub/event-processor-host/src/azureStorageCheckpointLeaseManager.ts index 0506cd495bf8..98e210f95852 100644 --- a/sdk/eventhub/event-processor-host/src/azureStorageCheckpointLeaseManager.ts +++ b/sdk/eventhub/event-processor-host/src/azureStorageCheckpointLeaseManager.ts @@ -25,7 +25,7 @@ import * as log from "./log"; import path from "path"; /** - * @ignore + * @hidden */ enum UploadActivity { create = "create", @@ -35,7 +35,7 @@ enum UploadActivity { } /** - * @ignore + * @hidden */ export class AzureStorageCheckpointLeaseManager implements CheckpointManager, LeaseManager { leaseRenewInterval: number; diff --git a/sdk/eventhub/event-processor-host/src/blobService.ts b/sdk/eventhub/event-processor-host/src/blobService.ts index ceae2a65ccec..85abcab1e178 100644 --- a/sdk/eventhub/event-processor-host/src/blobService.ts +++ b/sdk/eventhub/event-processor-host/src/blobService.ts @@ -12,7 +12,7 @@ import { validateType, getStorageError } from "./util/utils"; import { defaultMaximumExecutionTimeInMs } from "./util/constants"; import path from "path"; /** - * @ignore + * @hidden */ export interface CreateContainerResult { created: StorageBlobService.ContainerResult; @@ -20,7 +20,7 @@ export interface CreateContainerResult { } /** - * @ignore + * @hidden */ export enum LeaseState { /** @@ -55,7 +55,7 @@ export enum LeaseState { } /** - * @ignore + * @hidden */ export class BlobService { private _hostName: string; diff --git a/sdk/eventhub/event-processor-host/src/hostContext.ts b/sdk/eventhub/event-processor-host/src/hostContext.ts index 1e634054a3e1..b53a73c62956 100644 --- a/sdk/eventhub/event-processor-host/src/hostContext.ts +++ b/sdk/eventhub/event-processor-host/src/hostContext.ts @@ -45,7 +45,7 @@ import { } from "./util/constants"; /** - * @ignore + * @hidden */ export interface BaseHostContext { hostName: string; @@ -79,7 +79,7 @@ export interface BaseHostContext { } /** - * @ignore + * @hidden */ export interface HostContextWithCheckpointLeaseManager extends BaseHostContext { leaseManager: LeaseManager; @@ -102,7 +102,7 @@ export interface HostContext extends HostContextWithPumpManager { } /** - * @ignore + * @hidden */ export namespace HostContext { function _validateLeaseDurationAndRenewInterval(duration: number, interval: number): void { @@ -338,7 +338,7 @@ export namespace HostContext { } (NODE-VERSION ${process.version}; ${os.type()} ${os.release()})`; /** - * @ignore + * @hidden */ export function getUserAgent(options: EventProcessorHostOptions): string { const finalUserAgent = options.userAgent ? `${userAgent},${options.userAgent}` : userAgent; @@ -346,7 +346,7 @@ export namespace HostContext { } /** - * @ignore + * @hidden */ export function create(hostName: string, options: EventProcessorHostOptions): HostContext { const context = _createWithPumpManager(hostName, options); diff --git a/sdk/eventhub/event-processor-host/src/log.ts b/sdk/eventhub/event-processor-host/src/log.ts index b38b76e3e0d0..97f95be3913a 100644 --- a/sdk/eventhub/event-processor-host/src/log.ts +++ b/sdk/eventhub/event-processor-host/src/log.ts @@ -3,78 +3,78 @@ import debugModule from "debug"; /** - * @ignore + * @hidden * log statements for error */ export const error = debugModule("azure:eph:error"); /** - * @ignore + * @hidden * log statements for lease */ export const baseLease = debugModule("azure:eph:baseLease"); /** - * @ignore + * @hidden * log statements for lease */ export const completeLease = debugModule("azure:eph:completeLease"); /** - * @ignore + * @hidden * log statements for azurebloblease */ export const azurebloblease = debugModule("azure:eph:azurebloblease"); /** - * @ignore + * @hidden * log statements for leaseManager */ export const leaseManager = debugModule("azure:eph:leaseManager"); /** - * @ignore + * @hidden * log statements for partitionManager */ export const partitionManager = debugModule("azure:eph:partitionManager"); /** - * @ignore + * @hidden * log statements for partitionManager */ export const partitionPump = debugModule("azure:eph:partitionPump"); /** - * @ignore + * @hidden * log statements for pumpManager */ export const pumpManager = debugModule("azure:eph:pumpManager"); /** - * @ignore + * @hidden * log statements for partitionScanner */ export const partitionScanner = debugModule("azure:eph:partitionScanner"); /** - * @ignore + * @hidden * log statements for host */ export const host = debugModule("azure:eph:host"); /** - * @ignore + * @hidden * log statements for blobService */ export const blobService = debugModule("azure:eph:blobService"); /** - * @ignore + * @hidden * log statements for partitionContext */ export const partitionContext = debugModule("azure:eph:partitionContext"); /** - * @ignore + * @hidden * log statements for checkpointLeaseMgr */ export const checkpointLeaseMgr = debugModule("azure:eph:checkpointLeaseMgr"); /** - * @ignore + * @hidden * log statements for checkpointLeaseMgr */ export const checkpoint = debugModule("azure:eph:checkpointInfo"); /** - * @ignore + * @hidden * log statements for checkpointLeaseMgr */ export const util = debugModule("azure:eph:util"); diff --git a/sdk/eventhub/event-processor-host/src/modelTypes.ts b/sdk/eventhub/event-processor-host/src/modelTypes.ts index 2e3462b2433d..4c0c6648c474 100644 --- a/sdk/eventhub/event-processor-host/src/modelTypes.ts +++ b/sdk/eventhub/event-processor-host/src/modelTypes.ts @@ -13,7 +13,7 @@ import { CheckpointManager } from "./checkpointManager"; import { LeaseManager } from "./leaseManager"; /** - * @ignore + * @hidden */ export enum CloseReason { leaseLost = "LeaseLost", diff --git a/sdk/eventhub/event-processor-host/src/partitionContext.ts b/sdk/eventhub/event-processor-host/src/partitionContext.ts index 0312c04a0563..47293f57c2ad 100644 --- a/sdk/eventhub/event-processor-host/src/partitionContext.ts +++ b/sdk/eventhub/event-processor-host/src/partitionContext.ts @@ -118,7 +118,7 @@ export class PartitionContext { } /** - * @ignore + * @hidden */ async getInitialOffset(): Promise { const startingCheckpoint = await this._context.checkpointManager.getCheckpoint( @@ -158,7 +158,7 @@ export class PartitionContext { } /** - * @ignore + * @hidden */ private async _persistCheckpoint(checkpoint: CheckpointInfo): Promise { const withHostAndPartiton = this._context.withHostAndPartition; diff --git a/sdk/eventhub/event-processor-host/src/partitionManager.ts b/sdk/eventhub/event-processor-host/src/partitionManager.ts index a7c47fe29367..ab1d9ffe2ee8 100644 --- a/sdk/eventhub/event-processor-host/src/partitionManager.ts +++ b/sdk/eventhub/event-processor-host/src/partitionManager.ts @@ -9,7 +9,7 @@ import { OnReceivedMessage, OnReceivedError, CloseReason } from "./modelTypes"; import { PartitionScanner } from "./partitionScanner"; /** - * @ignore + * @hidden */ export class PartitionManager { private _context: HostContextWithPumpManager; @@ -24,7 +24,7 @@ export class PartitionManager { } /** - * @ignore + * @hidden */ async start(onMessage: OnReceivedMessage, onError: OnReceivedError): Promise { validateType("onMessage", onMessage, true, "function"); @@ -48,7 +48,7 @@ export class PartitionManager { } /** - * @ignore + * @hidden */ async stop(): Promise { const withHost = this._context.withHost; @@ -69,7 +69,7 @@ export class PartitionManager { } /** - * @ignore + * @hidden */ shouldStop(): boolean { if (this._isCancelRequested) { @@ -84,7 +84,7 @@ export class PartitionManager { } /** - * @ignore + * @hidden */ private _reset(): void { const withHost = this._context.withHost; @@ -97,7 +97,7 @@ export class PartitionManager { } /** - * @ignore + * @hidden */ private async _run(): Promise { const withHost = this._context.withHost; @@ -134,7 +134,7 @@ export class PartitionManager { } /** - * @ignore + * @hidden */ private async _cachePartitionIds(): Promise { const hostName = this._context.hostName; @@ -154,7 +154,7 @@ export class PartitionManager { } /** - * @ignore + * @hidden */ private async _initializeStores(): Promise { const hostName = this._context.hostName; @@ -224,7 +224,7 @@ export class PartitionManager { } /** - * @ignore + * @hidden */ private async _scan(isFirst: boolean): Promise { const withHost = this._context.withHost; diff --git a/sdk/eventhub/event-processor-host/src/partitionPump.ts b/sdk/eventhub/event-processor-host/src/partitionPump.ts index 2c822998264e..78f1e54b89bd 100644 --- a/sdk/eventhub/event-processor-host/src/partitionPump.ts +++ b/sdk/eventhub/event-processor-host/src/partitionPump.ts @@ -21,7 +21,7 @@ import { AzureBlobLease } from "./azureBlobLease"; import { EPHActionStrings } from "./util/utils"; /** - * @ignore + * @hidden */ export class PartitionPump { private _context: HostContextWithCheckpointLeaseManager; diff --git a/sdk/eventhub/event-processor-host/src/partitionScanner.ts b/sdk/eventhub/event-processor-host/src/partitionScanner.ts index fa0ae456b926..040b578acb77 100644 --- a/sdk/eventhub/event-processor-host/src/partitionScanner.ts +++ b/sdk/eventhub/event-processor-host/src/partitionScanner.ts @@ -10,7 +10,7 @@ import * as log from "./log"; import { EPHDiagnosticInfo } from "./modelTypes"; /** - * @ignore + * @hidden */ export class PartitionScanner { private _context: HostContextWithPumpManager; diff --git a/sdk/eventhub/event-processor-host/src/pumpManager.ts b/sdk/eventhub/event-processor-host/src/pumpManager.ts index 5dc384fd8e10..03b13a2e3d0a 100644 --- a/sdk/eventhub/event-processor-host/src/pumpManager.ts +++ b/sdk/eventhub/event-processor-host/src/pumpManager.ts @@ -9,7 +9,7 @@ import { CloseReason } from "./modelTypes"; import { EPHActionStrings } from "./util/utils"; /** - * @ignore + * @hidden */ export class PumpManager { private _context: HostContextWithCheckpointLeaseManager; diff --git a/sdk/eventhub/event-processor-host/src/util/utils.ts b/sdk/eventhub/event-processor-host/src/util/utils.ts index c00996ee0f12..004f8eb42a80 100644 --- a/sdk/eventhub/event-processor-host/src/util/utils.ts +++ b/sdk/eventhub/event-processor-host/src/util/utils.ts @@ -60,7 +60,7 @@ export function validateType( } /** - * @ignore + * @hidden */ export interface StorageErrorInfo { name: string; @@ -71,7 +71,7 @@ export interface StorageErrorInfo { } /** - * @ignore + * @hidden */ export function getStorageError(err: StorageError): StorageErrorInfo { return { @@ -84,7 +84,7 @@ export function getStorageError(err: StorageError): StorageErrorInfo { } /** - * @ignore + * @hidden */ export interface RetryConfig { hostName: string; @@ -97,7 +97,7 @@ export interface RetryConfig { } /** - * @ignore + * @hidden */ export enum EPHActionStrings { acquireLease = "Acquire Lease", @@ -123,7 +123,7 @@ export enum EPHActionStrings { } /** - * @ignore + * @hidden */ export async function retry(config: RetryConfig): Promise { let createdOK: boolean = false; diff --git a/sdk/eventhub/event-processor-host/tsdoc.json b/sdk/eventhub/event-processor-host/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/eventhub/event-processor-host/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/eventhub/eventhubs-checkpointstore-blob/src/blobCheckpointStore.ts b/sdk/eventhub/eventhubs-checkpointstore-blob/src/blobCheckpointStore.ts index bd0a78d135ef..0360e0637975 100644 --- a/sdk/eventhub/eventhubs-checkpointstore-blob/src/blobCheckpointStore.ts +++ b/sdk/eventhub/eventhubs-checkpointstore-blob/src/blobCheckpointStore.ts @@ -298,7 +298,7 @@ type CheckpointMetadata = { }; /** - * @ignore + * @hidden * @internal */ export function parseIntOrThrow( diff --git a/sdk/eventhub/eventhubs-checkpointstore-blob/src/log.ts b/sdk/eventhub/eventhubs-checkpointstore-blob/src/log.ts index 79b91961782d..00508d83ccae 100644 --- a/sdk/eventhub/eventhubs-checkpointstore-blob/src/log.ts +++ b/sdk/eventhub/eventhubs-checkpointstore-blob/src/log.ts @@ -12,7 +12,7 @@ export const logger = createClientLogger("eventhubs-checkpointstore-blob"); /** * Logs the error's stack trace to "verbose" if a stack trace is available. * @param error Error containing a stack trace. - * @ignore + * @hidden */ export function logErrorStackTrace(error: any) { if (error && error.stack) { diff --git a/sdk/eventhub/eventhubs-checkpointstore-blob/src/util/error.ts b/sdk/eventhub/eventhubs-checkpointstore-blob/src/util/error.ts index 6dac16c636f4..dd4d7460344b 100644 --- a/sdk/eventhub/eventhubs-checkpointstore-blob/src/util/error.ts +++ b/sdk/eventhub/eventhubs-checkpointstore-blob/src/util/error.ts @@ -5,7 +5,7 @@ import { logger, logErrorStackTrace } from "../log"; /** * @internal - * @ignore + * @hidden * Logs and Throws TypeError if given parameter is undefined or null * @param methodName Name of the method that was passed the parameter * @param parameterName Name of the parameter to check diff --git a/sdk/eventhub/eventhubs-checkpointstore-blob/tsdoc.json b/sdk/eventhub/eventhubs-checkpointstore-blob/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/eventhub/eventhubs-checkpointstore-blob/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/search/search-documents/src/odataMetadataPolicy.ts b/sdk/search/search-documents/src/odataMetadataPolicy.ts index 96dbc84e2b0b..a7f724cc7ce2 100644 --- a/sdk/search/search-documents/src/odataMetadataPolicy.ts +++ b/sdk/search/search-documents/src/odataMetadataPolicy.ts @@ -18,7 +18,7 @@ export type MetadataLevel = "none" | "minimal"; /** * A policy factory for setting the Accept header to ignore odata metadata * @internal - * @ignore + * @hidden */ export function odataMetadataPolicy(metadataLevel: MetadataLevel): RequestPolicyFactory { return { diff --git a/sdk/search/search-documents/src/searchClient.ts b/sdk/search/search-documents/src/searchClient.ts index 8d6f055dfd4b..ff3c4765b73f 100644 --- a/sdk/search/search-documents/src/searchClient.ts +++ b/sdk/search/search-documents/src/searchClient.ts @@ -82,7 +82,7 @@ export class SearchClient { /** * @internal - * @ignore + * @hidden * A reference to the auto-generated SearchClient */ private readonly client: GeneratedClient; diff --git a/sdk/search/search-documents/src/searchIndexClient.ts b/sdk/search/search-documents/src/searchIndexClient.ts index d6030e2765fe..88c14aed8385 100644 --- a/sdk/search/search-documents/src/searchIndexClient.ts +++ b/sdk/search/search-documents/src/searchIndexClient.ts @@ -65,7 +65,7 @@ export class SearchIndexClient { /** * @internal - * @ignore + * @hidden * A reference to the auto-generated SearchServiceClient */ private readonly client: GeneratedClient; diff --git a/sdk/search/search-documents/src/searchIndexerClient.ts b/sdk/search/search-documents/src/searchIndexerClient.ts index 45cfc11903cb..dfa6edad9c36 100644 --- a/sdk/search/search-documents/src/searchIndexerClient.ts +++ b/sdk/search/search-documents/src/searchIndexerClient.ts @@ -64,7 +64,7 @@ export class SearchIndexerClient { /** * @internal - * @ignore + * @hidden * A reference to the auto-generated SearchServiceClient */ private readonly client: GeneratedClient; diff --git a/sdk/search/search-documents/src/tracing.ts b/sdk/search/search-documents/src/tracing.ts index 9fdc015b9b93..ac2d86b43adc 100644 --- a/sdk/search/search-documents/src/tracing.ts +++ b/sdk/search/search-documents/src/tracing.ts @@ -9,7 +9,7 @@ type OperationTracingOptions = OperationOptions["tracingOptions"]; /** * Creates a span using the global tracer. - * @ignore + * @hidden * @param name The name of the operation being performed. * @param tracingOptions The options for the underlying http request. */ diff --git a/sdk/search/search-documents/tsdoc.json b/sdk/search/search-documents/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/search/search-documents/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/servicebus/service-bus/src/connectionContext.ts b/sdk/servicebus/service-bus/src/connectionContext.ts index ecec9edc9dbf..7657d8f941e1 100644 --- a/sdk/servicebus/service-bus/src/connectionContext.ts +++ b/sdk/servicebus/service-bus/src/connectionContext.ts @@ -23,7 +23,7 @@ import { SharedKeyCredential } from "./servicebusSharedKeyCredential"; /** * @internal - * @ignore + * @hidden * Provides contextual information like the underlying amqp connection, cbs session, management session, * tokenCredential, senders, receivers, etc. about the ServiceBus client. */ @@ -89,7 +89,7 @@ export interface ConnectionContext extends ConnectionContextBase { /** * Describes the members on the ConnectionContext that are only * used by it internally. - * @ignore + * @hidden * @internal */ export interface ConnectionContextInternalMembers extends ConnectionContext { @@ -106,19 +106,19 @@ export interface ConnectionContextInternalMembers extends ConnectionContext { /** * @internal - * @ignore + * @hidden * Helper type to get the names of all the functions on an object. */ type FunctionPropertyNames = { [K in keyof T]: T[K] extends Function ? K : never }[keyof T]; /** * @internal - * @ignore + * @hidden * Helper type to get the types of all the functions on an object. */ type FunctionProperties = Pick>; /** * @internal - * @ignore + * @hidden * Helper type to get the types of all the functions on ConnectionContext * and the internal methods from ConnectionContextInternalMembers. * Note that this excludes the functions that ConnectionContext inherits. @@ -132,7 +132,7 @@ type ConnectionContextMethods = Omit< /** * @internal - * @ignore + * @hidden */ export namespace ConnectionContext { export function create( diff --git a/sdk/servicebus/service-bus/src/constructorHelpers.ts b/sdk/servicebus/service-bus/src/constructorHelpers.ts index c4fbb5fd16e8..f0696a56abae 100644 --- a/sdk/servicebus/service-bus/src/constructorHelpers.ts +++ b/sdk/servicebus/service-bus/src/constructorHelpers.ts @@ -28,7 +28,7 @@ export interface ServiceBusClientOptions { /** * @internal - * @ignore + * @hidden * * @param {string} connectionString * @param {(SharedKeyCredential | TokenCredential)} credential @@ -52,7 +52,7 @@ export function createConnectionContext( * @param connectionString * @param options * @internal - * @ignore + * @hidden */ export function createConnectionContextForConnectionString( connectionString: string, @@ -68,7 +68,7 @@ export function createConnectionContextForConnectionString( * @param host * @param options * @internal - * @ignore + * @hidden */ export function createConnectionContextForTokenCredential( credential: TokenCredential, @@ -91,7 +91,7 @@ export function createConnectionContextForTokenCredential( * Parses a connection string and extracts the EntityPath named entity out. * @param connectionString An entity specific Service Bus connection string. * @internal - * @ignore + * @hidden */ export function getEntityNameFromConnectionString(connectionString: string): string { const entityPathMatch = connectionString.match(/^.+EntityPath=(.+?);{0,1}$/); diff --git a/sdk/servicebus/service-bus/src/core/autoLockRenewer.ts b/sdk/servicebus/service-bus/src/core/autoLockRenewer.ts index 39c28966940d..0cd0aea09198 100644 --- a/sdk/servicebus/service-bus/src/core/autoLockRenewer.ts +++ b/sdk/servicebus/service-bus/src/core/autoLockRenewer.ts @@ -10,7 +10,7 @@ import { OnErrorNoContext } from "./messageReceiver"; /** * @internal - * @ignore + * @hidden */ export type RenewableMessageProperties = Readonly< Pick @@ -20,7 +20,7 @@ export type RenewableMessageProperties = Readonly< /** * @internal - * @ignore + * @hidden */ type MinimalLink = Pick, "name" | "logPrefix" | "entityPath">; @@ -28,7 +28,7 @@ type MinimalLink = Pick, "name" | "logPrefix" | "entityPath">; * Tracks locks for messages, renewing until a configurable duration. * * @internal - * @ignore + * @hidden */ export class LockRenewer { /** diff --git a/sdk/servicebus/service-bus/src/core/batchingReceiver.ts b/sdk/servicebus/service-bus/src/core/batchingReceiver.ts index f4bf498840fd..4df99abb37a8 100644 --- a/sdk/servicebus/service-bus/src/core/batchingReceiver.ts +++ b/sdk/servicebus/service-bus/src/core/batchingReceiver.ts @@ -26,7 +26,7 @@ import { ServiceBusError, translateServiceBusError } from "../serviceBusError"; * Describes the batching receiver where the user can receive a specified number of messages for * a predefined time. * @internal - * @ignore + * @hidden * @class BatchingReceiver * @extends MessageReceiver */ @@ -165,7 +165,7 @@ export class BatchingReceiver extends MessageReceiver { * @param maxTimeAfterFirstMessageInMs Maximum time to wait after the first message before completing the receive. * * @internal - * @ignore + * @hidden */ export function getRemainingWaitTimeInMsFn( maxWaitTimeInMs: number, @@ -189,7 +189,7 @@ export function getRemainingWaitTimeInMsFn( * import the events definition (which is annoying with browsers). * * @internal - * @ignore + * @hidden */ type EventEmitterLike = Pick; @@ -198,7 +198,7 @@ type EventEmitterLike = Pick & EventEmitterLike & { @@ -211,13 +211,13 @@ export type MinimalReceiver = Pick; /** * @internal - * @ignore + * @hidden */ interface ReceiveMessageArgs extends OperationOptionsBase { maxMessageCount: number; @@ -232,7 +232,7 @@ interface ReceiveMessageArgs extends OperationOptionsBase { * Usable with both session and non-session receivers. * * @internal - * @ignore + * @hidden */ export class BatchingReceiverLite { /** @@ -280,7 +280,7 @@ export class BatchingReceiverLite { * Receives a set of messages, * * @internal - * @ignore + * @hidden */ public async receiveMessages(args: ReceiveMessageArgs): Promise { try { diff --git a/sdk/servicebus/service-bus/src/core/linkEntity.ts b/sdk/servicebus/service-bus/src/core/linkEntity.ts index c76f90589f8b..de493ec9f9ab 100644 --- a/sdk/servicebus/service-bus/src/core/linkEntity.ts +++ b/sdk/servicebus/service-bus/src/core/linkEntity.ts @@ -20,7 +20,7 @@ import { ServiceBusError } from "../serviceBusError"; /** * @internal - * @ignore + * @hidden * Options passed to the constructor of LinkEntity */ export interface LinkEntityOptions { @@ -39,7 +39,7 @@ export interface LinkEntityOptions { * with the ManagementClient today. * * @internal - * @ignore + * @hidden */ export interface RequestResponseLinkOptions { senderOptions: SenderOptions; @@ -49,7 +49,7 @@ export interface RequestResponseLinkOptions { /** * @internal - * @ignore + * @hidden */ export type ReceiverType = | "batching" // batching receiver @@ -58,7 +58,7 @@ export type ReceiverType = /** * @internal - * @ignore + * @hidden */ type LinkOptionsT< LinkT extends Receiver | AwaitableSender | RequestResponseLink @@ -72,7 +72,7 @@ type LinkOptionsT< /** * @internal - * @ignore + * @hidden */ type LinkTypeT< LinkT extends Receiver | AwaitableSender | RequestResponseLink @@ -86,7 +86,7 @@ type LinkTypeT< /** * @internal - * @ignore + * @hidden * Describes the base class for entities like MessageSender, MessageReceiver and Management client. */ export abstract class LinkEntity { diff --git a/sdk/servicebus/service-bus/src/core/managementClient.ts b/sdk/servicebus/service-bus/src/core/managementClient.ts index 6b5906128b7e..8af0d74e26eb 100644 --- a/sdk/servicebus/service-bus/src/core/managementClient.ts +++ b/sdk/servicebus/service-bus/src/core/managementClient.ts @@ -52,7 +52,7 @@ import { defaultDataTransformer } from "../dataTransformer"; /** * @internal - * @ignore + * @hidden */ export interface SendManagementRequestOptions extends SendRequestOptions { /** @@ -131,7 +131,7 @@ export interface CorrelationRuleFilter { /** * @internal - * @ignore + * @hidden */ const correlationProperties = [ "correlationId", @@ -147,7 +147,7 @@ const correlationProperties = [ /** * @internal - * @ignore + * @hidden * Options to set when updating the disposition status */ export interface DispositionStatusOptions extends OperationOptionsBase { @@ -174,7 +174,7 @@ export interface DispositionStatusOptions extends OperationOptionsBase { /** * @internal - * @ignore + * @hidden * Options passed to the constructor of ManagementClient */ export interface ManagementClientOptions { @@ -184,7 +184,7 @@ export interface ManagementClientOptions { /** * @internal - * @ignore + * @hidden * @class ManagementClient * Describes the ServiceBus Management Client that talks * to the $management endpoint over AMQP connection. diff --git a/sdk/servicebus/service-bus/src/core/messageReceiver.ts b/sdk/servicebus/service-bus/src/core/messageReceiver.ts index 97b02ed71553..359858e64ef0 100644 --- a/sdk/servicebus/service-bus/src/core/messageReceiver.ts +++ b/sdk/servicebus/service-bus/src/core/messageReceiver.ts @@ -22,7 +22,7 @@ import { translateServiceBusError } from "../serviceBusError"; /** * @internal - * @ignore + * @hidden */ export type ReceiverHandlers = Pick< ReceiverOptions, @@ -31,7 +31,7 @@ export type ReceiverHandlers = Pick< /** * @internal - * @ignore + * @hidden */ export interface OnAmqpEventAsPromise extends OnAmqpEvent { (context: EventContext): Promise; @@ -39,7 +39,7 @@ export interface OnAmqpEventAsPromise extends OnAmqpEvent { /** * @internal - * @ignore + * @hidden */ export interface ReceiveOptions extends SubscribeOptions { /** @@ -62,7 +62,7 @@ export interface ReceiveOptions extends SubscribeOptions { /** * Describes the signature of the message handler passed to `registerMessageHandler` method. * @internal - * @ignore + * @hidden */ export interface OnMessage { /** @@ -75,7 +75,7 @@ export interface OnMessage { * Describes the signature of the error handler passed to `registerMessageHandler` method. * * @internal - * @ignore + * @hidden */ export interface OnError { /** @@ -92,7 +92,7 @@ export interface OnError { * with an implicit ProcessErrorContext. Used by LockRenewer. * * @internal - * @ignore + * @hidden */ export interface OnErrorNoContext { (error: MessagingError | Error): void; @@ -100,7 +100,7 @@ export interface OnErrorNoContext { /** * @internal - * @ignore + * @hidden * Describes the MessageReceiver that will receive messages from ServiceBus. * @class MessageReceiver */ diff --git a/sdk/servicebus/service-bus/src/core/messageSender.ts b/sdk/servicebus/service-bus/src/core/messageSender.ts index cb94e01a92de..546020cb5ee3 100644 --- a/sdk/servicebus/service-bus/src/core/messageSender.ts +++ b/sdk/servicebus/service-bus/src/core/messageSender.ts @@ -40,7 +40,7 @@ import { defaultDataTransformer } from "../dataTransformer"; /** * @internal - * @ignore + * @hidden * Describes the MessageSender that will send messages to ServiceBus. * @class MessageSender */ diff --git a/sdk/servicebus/service-bus/src/core/receiverHelper.ts b/sdk/servicebus/service-bus/src/core/receiverHelper.ts index d49850ba59dc..13b80044931f 100644 --- a/sdk/servicebus/service-bus/src/core/receiverHelper.ts +++ b/sdk/servicebus/service-bus/src/core/receiverHelper.ts @@ -9,7 +9,7 @@ import { receiverLogger as logger } from "../log"; * like credits, draining, etc... * * @internal - * @ignore + * @hidden */ export class ReceiverHelper { private _isSuspended: boolean = false; diff --git a/sdk/servicebus/service-bus/src/core/shared.ts b/sdk/servicebus/service-bus/src/core/shared.ts index 6cb4d9e8e110..e03bf2729fef 100644 --- a/sdk/servicebus/service-bus/src/core/shared.ts +++ b/sdk/servicebus/service-bus/src/core/shared.ts @@ -7,7 +7,7 @@ import { receiverLogger } from "../log"; /** * @internal - * @ignore + * @hidden */ export interface DeferredPromiseAndTimer { resolve: (value?: any) => void; @@ -26,7 +26,7 @@ export interface DeferredPromiseAndTimer { * 5. User's code after the settlement continues. * * @internal - * @ignore + * @hidden */ export function onMessageSettled( logPrefix: string, diff --git a/sdk/servicebus/service-bus/src/core/streamingReceiver.ts b/sdk/servicebus/service-bus/src/core/streamingReceiver.ts index b4f64954048c..ed0163788f31 100644 --- a/sdk/servicebus/service-bus/src/core/streamingReceiver.ts +++ b/sdk/servicebus/service-bus/src/core/streamingReceiver.ts @@ -32,7 +32,7 @@ import { abandonMessage, completeMessage } from "../receivers/shared"; /** * @internal - * @ignore + * @hidden */ export interface StreamingReceiverInitArgs extends ReceiveOptions, @@ -42,7 +42,7 @@ export interface StreamingReceiverInitArgs /** * @internal - * @ignore + * @hidden * Describes the streaming receiver where the user can receive the message * by providing handler functions. * @class StreamingReceiver diff --git a/sdk/servicebus/service-bus/src/dataTransformer.ts b/sdk/servicebus/service-bus/src/dataTransformer.ts index 2c61feafdd1d..3541fa9ab474 100644 --- a/sdk/servicebus/service-bus/src/dataTransformer.ts +++ b/sdk/servicebus/service-bus/src/dataTransformer.ts @@ -9,7 +9,7 @@ import { logErrorStackTrace, logger } from "./log"; /** * The default data transformer that will be used by the Azure SDK. * @internal - * @ignore + * @hidden */ export const defaultDataTransformer = { /** diff --git a/sdk/servicebus/service-bus/src/diagnostics/instrumentServiceBusMessage.ts b/sdk/servicebus/service-bus/src/diagnostics/instrumentServiceBusMessage.ts index 6128290f3f97..6a4d8afcaba4 100644 --- a/sdk/servicebus/service-bus/src/diagnostics/instrumentServiceBusMessage.ts +++ b/sdk/servicebus/service-bus/src/diagnostics/instrumentServiceBusMessage.ts @@ -13,7 +13,7 @@ import { ServiceBusReceiver } from "../receivers/receiver"; import { ServiceBusMessage, ServiceBusReceivedMessage } from "../serviceBusMessage"; /** - * @ignore + * @hidden */ export const TRACEPARENT_PROPERTY = "Diagnostic-Id"; @@ -23,7 +23,7 @@ export const TRACEPARENT_PROPERTY = "Diagnostic-Id"; * has already been instrumented. * @param message The `ServiceBusMessage` to instrument. * @param span The `Span` containing the context to propagate tracing information. - * @ignore + * @hidden * @internal */ export function instrumentServiceBusMessage( @@ -49,7 +49,7 @@ export function instrumentServiceBusMessage( * Extracts the `SpanContext` from an `ServiceBusMessage` if the context exists. * @param message An individual `ServiceBusMessage` object. * @internal - * @ignore + * @hidden */ export function extractSpanContextFromServiceBusMessage( message: ServiceBusMessage @@ -68,7 +68,7 @@ export function extractSpanContextFromServiceBusMessage( * * @param receivedMessages A single message or a set of messages * @internal - * @ignore + * @hidden */ function* getReceivedMessages( receivedMessages: ServiceBusReceivedMessage | ServiceBusReceivedMessage[] @@ -92,7 +92,7 @@ function* getReceivedMessages( * give the message to the user. * * @internal - * @ignore + * @hidden */ export function createProcessingSpan( receivedMessages: ServiceBusReceivedMessage | ServiceBusReceivedMessage[], @@ -141,7 +141,7 @@ export function createProcessingSpan( * know the scope. * * @internal - * @ignore + * @hidden */ export function createAndEndProcessingSpan( receivedMessages: ServiceBusReceivedMessage | ServiceBusReceivedMessage[], diff --git a/sdk/servicebus/service-bus/src/diagnostics/messageSpan.ts b/sdk/servicebus/service-bus/src/diagnostics/messageSpan.ts index 0202e099abd0..b00108508a5a 100644 --- a/sdk/servicebus/service-bus/src/diagnostics/messageSpan.ts +++ b/sdk/servicebus/service-bus/src/diagnostics/messageSpan.ts @@ -7,7 +7,7 @@ import { Span, SpanContext, SpanKind } from "@opentelemetry/api"; /** * @internal - * @ignore + * @hidden */ export function createMessageSpan( parentSpan?: Span | SpanContext | null, diff --git a/sdk/servicebus/service-bus/src/log.ts b/sdk/servicebus/service-bus/src/log.ts index 74641c578aa2..fbc8fbd731ae 100644 --- a/sdk/servicebus/service-bus/src/log.ts +++ b/sdk/servicebus/service-bus/src/log.ts @@ -8,49 +8,49 @@ import { AmqpError } from "rhea-promise"; * The @azure/logger configuration for this package. * This will output logs using the `azure:service-bus` namespace prefix. * @internal - * @ignore + * @hidden */ export const logger = createServiceBusLogger("service-bus"); /** * Logging for ServiceBusReceivers of any type (session, non-session) * @internal - * @ignore + * @hidden */ export const receiverLogger = createServiceBusLogger("service-bus:receiver"); /** * Logging for ServiceBusSenders * @internal - * @ignore + * @hidden */ export const senderLogger = createServiceBusLogger("service-bus:sender"); /** * Logging for connection management * @internal - * @ignore + * @hidden */ export const connectionLogger = createServiceBusLogger("service-bus:connection"); /** * Logging for the ServiceBusAdministrationClient * @internal - * @ignore + * @hidden */ export const administrationLogger = createServiceBusLogger("service-bus:administration"); /** * Logging related to message encoding/decoding. * @internal - * @ignore + * @hidden */ export const messageLogger = createServiceBusLogger("service-bus:messages"); /** * Logging related to message encoding/decoding. * @internal - * @ignore + * @hidden */ export const managementClientLogger = createServiceBusLogger("service-bus:management"); @@ -58,7 +58,7 @@ export const managementClientLogger = createServiceBusLogger("service-bus:manage * Logs the error's stack trace to "verbose" if a stack trace is available. * @param error Error containing a stack trace. * @internal - * @ignore + * @hidden */ export function logErrorStackTrace(_logger: AzureLogger, error: any) { if (error && error.stack) { @@ -68,7 +68,7 @@ export function logErrorStackTrace(_logger: AzureLogger, error: any) { /** * @internal - * @ignore + * @hidden */ export interface ServiceBusLogger extends AzureLogger { /** @@ -88,7 +88,7 @@ export interface ServiceBusLogger extends AzureLogger { /** * Creates an AzureLogger with any additional methods for standardized logging (for example, with errors) * @internal - * @ignore + * @hidden */ export function createServiceBusLogger(namespace: string) { const _logger = createClientLogger(namespace) as ServiceBusLogger; @@ -121,7 +121,7 @@ export function createServiceBusLogger(namespace: string) { /** * @internal - * @ignore + * @hidden */ function isError(err: Error | AmqpError | undefined): err is Error { return err != null && (err as any).name != null; diff --git a/sdk/servicebus/service-bus/src/models.ts b/sdk/servicebus/service-bus/src/models.ts index 2c93c2a32292..0525788f1dc2 100644 --- a/sdk/servicebus/service-bus/src/models.ts +++ b/sdk/servicebus/service-bus/src/models.ts @@ -54,7 +54,7 @@ export interface MessageHandlers { /** * @internal - * @ignore + * @hidden */ export interface InternalMessageHandlers extends MessageHandlers { /** @@ -68,7 +68,7 @@ export interface InternalMessageHandlers extends MessageHandlers { /** * Represents the possible receive modes for the receiver. * @internal - * @ignore + * @hidden */ export type ReceiveMode = "peekLock" | "receiveAndDelete"; diff --git a/sdk/servicebus/service-bus/src/modelsToBeSharedWithEventHubs.ts b/sdk/servicebus/service-bus/src/modelsToBeSharedWithEventHubs.ts index 8661ce4bf42f..efacc30f9263 100644 --- a/sdk/servicebus/service-bus/src/modelsToBeSharedWithEventHubs.ts +++ b/sdk/servicebus/service-bus/src/modelsToBeSharedWithEventHubs.ts @@ -16,7 +16,7 @@ export type OperationOptionsBase = Pick(fn: () => Promise, span: Span): Promise { diff --git a/sdk/servicebus/service-bus/src/receivers/receiver.ts b/sdk/servicebus/service-bus/src/receivers/receiver.ts index 38713ee1da17..b5ad33dc7ae7 100644 --- a/sdk/servicebus/service-bus/src/receivers/receiver.ts +++ b/sdk/servicebus/service-bus/src/receivers/receiver.ts @@ -270,7 +270,7 @@ export interface ServiceBusReceiver { /** * @internal - * @ignore + * @hidden */ export class ServiceBusReceiverImpl implements ServiceBusReceiver { private _retryOptions: RetryOptions; @@ -765,6 +765,6 @@ export class ServiceBusReceiverImpl implements ServiceBusReceiver { * This timeout only applies to receiveMessages() * * @internal - * @ignore + * @hidden */ export const defaultMaxTimeAfterFirstMessageForBatchingMs = 1000; diff --git a/sdk/servicebus/service-bus/src/receivers/sessionReceiver.ts b/sdk/servicebus/service-bus/src/receivers/sessionReceiver.ts index b4ee295b1b42..da50f8cad1cd 100644 --- a/sdk/servicebus/service-bus/src/receivers/sessionReceiver.ts +++ b/sdk/servicebus/service-bus/src/receivers/sessionReceiver.ts @@ -111,7 +111,7 @@ export interface ServiceBusSessionReceiver extends ServiceBusReceiver { /** * @internal - * @ignore + * @hidden */ export class ServiceBusSessionReceiverImpl implements ServiceBusSessionReceiver { public sessionId: string; diff --git a/sdk/servicebus/service-bus/src/receivers/shared.ts b/sdk/servicebus/service-bus/src/receivers/shared.ts index 4ec74b70de5a..38e717873146 100644 --- a/sdk/servicebus/service-bus/src/receivers/shared.ts +++ b/sdk/servicebus/service-bus/src/receivers/shared.ts @@ -19,7 +19,7 @@ import { MessageAlreadySettled } from "../util/errors"; /** * @internal - * @ignore + * @hidden */ export function assertValidMessageHandlers(handlers: any) { if ( @@ -35,7 +35,7 @@ export function assertValidMessageHandlers(handlers: any) { /** * @internal - * @ignore + * @hidden */ export async function* getMessageIterator( receiver: Pick, @@ -54,7 +54,7 @@ export async function* getMessageIterator( /** * @internal - * @ignore + * @hidden */ export function wrapProcessErrorHandler( handlers: Pick, @@ -72,7 +72,7 @@ export function wrapProcessErrorHandler( /** * @internal - * @ignore + * @hidden * * @param {ServiceBusMessageImpl} message * @param {ConnectionContext} context @@ -93,7 +93,7 @@ export function completeMessage( /** * @internal - * @ignore + * @hidden * * @param {ServiceBusMessageImpl} message * @param {ConnectionContext} context @@ -118,7 +118,7 @@ export function abandonMessage( /** * @internal - * @ignore + * @hidden * * @param {ServiceBusMessageImpl} message * @param {ConnectionContext} context @@ -143,7 +143,7 @@ export function deferMessage( /** * @internal - * @ignore + * @hidden * * @param {ServiceBusMessageImpl} message * @param {ConnectionContext} context @@ -187,7 +187,7 @@ export function deadLetterMessage( /** * @internal - * @ignore + * @hidden * * @param {ServiceBusMessageImpl} message * @param {DispositionType} operation diff --git a/sdk/servicebus/service-bus/src/sender.ts b/sdk/servicebus/service-bus/src/sender.ts index c824f3499813..ef4ac2661f92 100644 --- a/sdk/servicebus/service-bus/src/sender.ts +++ b/sdk/servicebus/service-bus/src/sender.ts @@ -130,7 +130,7 @@ export interface ServiceBusSender { /** * @internal - * @ignore + * @hidden * @class ServiceBusSenderImpl * @implements {ServiceBusSender} */ @@ -342,7 +342,7 @@ export class ServiceBusSenderImpl implements ServiceBusSender { /** * @internal - * @ignore + * @hidden */ export function isServiceBusMessageBatch( messageBatchOrAnything: any diff --git a/sdk/servicebus/service-bus/src/serializers/namespaceResourceSerializer.ts b/sdk/servicebus/service-bus/src/serializers/namespaceResourceSerializer.ts index ce4c5a2fc446..7d9c9f0a0873 100644 --- a/sdk/servicebus/service-bus/src/serializers/namespaceResourceSerializer.ts +++ b/sdk/servicebus/service-bus/src/serializers/namespaceResourceSerializer.ts @@ -43,7 +43,7 @@ export interface NamespaceProperties { /** * @internal - * @ignore + * @hidden * Builds the namespace object from the raw json object gotten after deserializing the * response from the service * @param rawNamespace @@ -66,7 +66,7 @@ export function buildNamespace(rawNamespace: any): NamespaceProperties { /** * @internal - * @ignore + * @hidden * Atom XML Serializer for Namespaces. */ export class NamespaceResourceSerializer implements AtomXmlSerializer { diff --git a/sdk/servicebus/service-bus/src/serializers/queueResourceSerializer.ts b/sdk/servicebus/service-bus/src/serializers/queueResourceSerializer.ts index e2ba0fcccdb5..7a5a60a11ab8 100644 --- a/sdk/servicebus/service-bus/src/serializers/queueResourceSerializer.ts +++ b/sdk/servicebus/service-bus/src/serializers/queueResourceSerializer.ts @@ -25,7 +25,7 @@ import { /** * @internal - * @ignore + * @hidden * Builds the queue options object from the user provided options. * Handles the differences in casing for the property names, * converts values to string and ensures the right order as expected by the service @@ -56,7 +56,7 @@ export function buildQueueOptions(queue: CreateQueueOptions): InternalQueueOptio /** * @internal - * @ignore + * @hidden * Builds the queue object from the raw json object gotten after deserializing the * response from the service * @param rawQueue @@ -114,7 +114,7 @@ export function buildQueue(rawQueue: any): QueueProperties { /** * @internal - * @ignore + * @hidden * Builds the queue runtime info object from the raw json object gotten after deserializing the * response from the service * @param rawQueue @@ -415,7 +415,7 @@ export interface QueueProperties { } /** * @internal - * @ignore + * @hidden * Internal representation of settable options on a queue */ export interface InternalQueueOptions { @@ -616,7 +616,7 @@ export interface QueueRuntimeProperties { /** * @internal - * @ignore + * @hidden * Atom XML Serializer for Queues. */ export class QueueResourceSerializer implements AtomXmlSerializer { diff --git a/sdk/servicebus/service-bus/src/serializers/ruleResourceSerializer.ts b/sdk/servicebus/service-bus/src/serializers/ruleResourceSerializer.ts index 19165ea4df95..2441a910a84b 100644 --- a/sdk/servicebus/service-bus/src/serializers/ruleResourceSerializer.ts +++ b/sdk/servicebus/service-bus/src/serializers/ruleResourceSerializer.ts @@ -13,7 +13,7 @@ import { getString, getStringOrUndefined } from "../util/utils"; /** * @internal - * @ignore + * @hidden * Builds the rule object from the raw json object gotten after deserializing the * response from the service * @param rawRule @@ -28,7 +28,7 @@ export function buildRule(rawRule: any): RuleProperties { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve `filter` value from given input, * or undefined if not passed in. * @param value @@ -62,7 +62,7 @@ function getTopicFilter(value: any): SqlRuleFilter | CorrelationRuleFilter { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve rule `action` value from given input. * @param value */ @@ -76,7 +76,7 @@ function getRuleAction(value: any): SqlRuleAction { /** * Represents the options to create a rule for a subscription. * @internal - * @ignore + * @hidden */ export interface CreateRuleOptions { /** @@ -156,7 +156,7 @@ export interface SqlRuleFilter { /** * @internal - * @ignore + * @hidden * * @interface InternalRuleOptions */ @@ -168,7 +168,7 @@ export interface InternalRuleOptions { /** * @internal - * @ignore + * @hidden * * @param {CreateRuleOptions} rule */ @@ -246,7 +246,7 @@ export function buildInternalRuleResource(rule: CreateRuleOptions): InternalRule /** * @internal - * @ignore + * @hidden * RuleResourceSerializer for serializing / deserializing Rule entities */ export class RuleResourceSerializer implements AtomXmlSerializer { @@ -261,7 +261,7 @@ export class RuleResourceSerializer implements AtomXmlSerializer { /** * @internal - * @ignore + * @hidden */ export function isSqlRuleAction(action: any): action is SqlRuleAction { return action != null && typeof action === "object" && "sqlExpression" in action; @@ -272,7 +272,7 @@ export function isSqlRuleAction(action: any): action is SqlRuleAction { * the request would fail otherwise. * * @internal - * @ignore + * @hidden */ enum TypeMapForRequestSerialization { double = "l28:double", @@ -284,7 +284,7 @@ enum TypeMapForRequestSerialization { /** * @internal - * @ignore + * @hidden */ enum TypeMapForResponseDeserialization { int = "int", @@ -296,7 +296,7 @@ enum TypeMapForResponseDeserialization { /** * @internal - * @ignore + * @hidden * Internal representation of key-value pair */ type RawKeyValuePair = { @@ -306,7 +306,7 @@ type RawKeyValuePair = { /** * @internal - * @ignore + * @hidden */ interface InternalRawKeyValuePairs { KeyValueOfstringanyType: RawKeyValuePair[]; @@ -316,13 +316,13 @@ interface InternalRawKeyValuePairs { * Key-value pairs are supposed to be wrapped with this tag in the XML request, they are ignored otherwise. * * @internal - * @ignore + * @hidden */ const keyValuePairXMLTag = "KeyValueOfstringanyType"; /** * @internal - * @ignore + * @hidden * Helper utility to retrieve the key-value pairs from the RawKeyValue object from given input, * or undefined if not passed in. * @param value @@ -380,7 +380,7 @@ function getKeyValuePairsOrUndefined( /** * @internal - * @ignore + * @hidden * Helper utility to extract array of user properties key-value instances from given input, * or undefined if not passed in. * @param value diff --git a/sdk/servicebus/service-bus/src/serializers/subscriptionResourceSerializer.ts b/sdk/servicebus/service-bus/src/serializers/subscriptionResourceSerializer.ts index 4ad1dc535d2f..9b6efae1e35b 100644 --- a/sdk/servicebus/service-bus/src/serializers/subscriptionResourceSerializer.ts +++ b/sdk/servicebus/service-bus/src/serializers/subscriptionResourceSerializer.ts @@ -28,7 +28,7 @@ import { /** * @internal - * @ignore + * @hidden * Builds the subscription options object from the user provided options. * Handles the differences in casing for the property names, * converts values to string and ensures the right order as expected by the service @@ -63,7 +63,7 @@ export function buildSubscriptionOptions( /** * @internal - * @ignore + * @hidden * Builds the subscription object from the raw json object gotten after deserializing * the response from the service * @param rawSubscription @@ -114,7 +114,7 @@ export function buildSubscription(rawSubscription: any): SubscriptionProperties /** * @internal - * @ignore + * @hidden * Builds the subscription runtime info object from the raw json object gotten after deserializing * the response from the service * @param rawSubscription @@ -392,7 +392,7 @@ export interface SubscriptionProperties { /** * @internal - * @ignore + * @hidden * Internal representation of settable options on a subscription */ export interface InternalSubscriptionOptions { @@ -560,7 +560,7 @@ export interface SubscriptionRuntimeProperties { /** * @internal - * @ignore + * @hidden * SubscriptionResourceSerializer for serializing / deserializing Subscription entities */ export class SubscriptionResourceSerializer implements AtomXmlSerializer { diff --git a/sdk/servicebus/service-bus/src/serializers/topicResourceSerializer.ts b/sdk/servicebus/service-bus/src/serializers/topicResourceSerializer.ts index ea0642057ea4..3abf5e4d85db 100644 --- a/sdk/servicebus/service-bus/src/serializers/topicResourceSerializer.ts +++ b/sdk/servicebus/service-bus/src/serializers/topicResourceSerializer.ts @@ -25,7 +25,7 @@ import { /** * @internal - * @ignore + * @hidden * Builds the topic options object from the user provided options. * Handles the differences in casing for the property names, * converts values to string and ensures the right order as expected by the service @@ -51,7 +51,7 @@ export function buildTopicOptions(topic: CreateTopicOptions): InternalTopicOptio /** * @internal - * @ignore + * @hidden * Builds the topic object from the raw json object gotten after deserializing the * response from the service * @param rawTopic @@ -96,7 +96,7 @@ export function buildTopic(rawTopic: any): TopicProperties { /** * @internal - * @ignore + * @hidden * Builds the topic runtime info object from the raw json object gotten after deserializing the * response from the service * @param rawTopic @@ -314,7 +314,7 @@ export interface TopicProperties { /** * @internal - * @ignore + * @hidden * Internal representation of settable options on a topic */ export interface InternalTopicOptions { @@ -453,7 +453,7 @@ export interface TopicRuntimeProperties { /** * @internal - * @ignore + * @hidden * TopicResourceSerializer for serializing / deserializing Topic entities */ export class TopicResourceSerializer implements AtomXmlSerializer { diff --git a/sdk/servicebus/service-bus/src/serviceBusClient.ts b/sdk/servicebus/service-bus/src/serviceBusClient.ts index ea91dc6596bb..8d6d58860ccd 100644 --- a/sdk/servicebus/service-bus/src/serviceBusClient.ts +++ b/sdk/servicebus/service-bus/src/serviceBusClient.ts @@ -434,7 +434,7 @@ export class ServiceBusClient { * topic, subscription, options * * @internal - * @ignore + * @hidden */ export function extractReceiverArguments( queueOrTopicName1: string, @@ -479,7 +479,7 @@ export function extractReceiverArguments = new Map([ ["MessagingEntityNotFoundError", "MessagingEntityNotFound"], @@ -159,7 +159,7 @@ export class ServiceBusError extends MessagingError { * Service Bus specific handling of the error (falling back to default translate behavior otherwise). * * @internal - * @ignore + * @hidden */ export function translateServiceBusError(err: AmqpError | Error): ServiceBusError | Error { if (isServiceBusError(err)) { diff --git a/sdk/servicebus/service-bus/src/serviceBusMessage.ts b/sdk/servicebus/service-bus/src/serviceBusMessage.ts index 783fc9b4b10c..94045826ac40 100644 --- a/sdk/servicebus/service-bus/src/serviceBusMessage.ts +++ b/sdk/servicebus/service-bus/src/serviceBusMessage.ts @@ -18,7 +18,7 @@ import { reorderLockToken } from "./util/utils"; /** * @internal - * @ignore + * @hidden */ export enum DispositionType { complete = "complete", @@ -29,7 +29,7 @@ export enum DispositionType { /** * @internal - * @ignore + * @hidden * Describes the delivery annotations for Service Bus. */ export interface ServiceBusDeliveryAnnotations extends DeliveryAnnotations { @@ -57,7 +57,7 @@ export interface ServiceBusDeliveryAnnotations extends DeliveryAnnotations { /** * @internal - * @ignore + * @hidden * Describes the message annotations for Service Bus. */ export interface ServiceBusMessageAnnotations extends MessageAnnotations { @@ -217,7 +217,7 @@ export interface ServiceBusMessage { /** * @internal - * @ignore + * @hidden * Gets the error message for when a property on given message is not of expected type */ export function getMessagePropertyTypeMismatchError(msg: ServiceBusMessage): Error | undefined { @@ -275,7 +275,7 @@ export function getMessagePropertyTypeMismatchError(msg: ServiceBusMessage): Err /** * @internal - * @ignore + * @hidden * Converts given ServiceBusMessage to RheaMessage */ export function toRheaMessage(msg: ServiceBusMessage): RheaMessage { @@ -444,7 +444,7 @@ export interface ServiceBusReceivedMessage extends ServiceBusMessage { /** * @internal - * @ignore + * @hidden * Converts given RheaMessage to ServiceBusReceivedMessage */ export function fromRheaMessage( @@ -563,7 +563,7 @@ export function fromRheaMessage( /** * @internal - * @ignore + * @hidden */ export function isServiceBusMessage(possible: any): possible is ServiceBusMessage { return possible != null && typeof possible === "object" && "body" in possible; @@ -573,7 +573,7 @@ export function isServiceBusMessage(possible: any): possible is ServiceBusMessag * Describes the message received from Service Bus. * * @internal - * @ignore + * @hidden * @class ServiceBusMessageImpl * @implements {ServiceBusReceivedMessage} */ diff --git a/sdk/servicebus/service-bus/src/serviceBusMessageBatch.ts b/sdk/servicebus/service-bus/src/serviceBusMessageBatch.ts index 41e0c0dfe5cb..1c03ad508f84 100644 --- a/sdk/servicebus/service-bus/src/serviceBusMessageBatch.ts +++ b/sdk/servicebus/service-bus/src/serviceBusMessageBatch.ts @@ -25,19 +25,19 @@ import { defaultDataTransformer } from "./dataTransformer"; /** * @internal - * @ignore + * @hidden * The amount of bytes to reserve as overhead for a small message. */ const smallMessageOverhead = 5; /** * @internal - * @ignore + * @hidden * The amount of bytes to reserve as overhead for a large message. */ const largeMessageOverhead = 8; /** * @internal - * @ignore + * @hidden * The maximum number of bytes that a message may be to be considered small. */ const smallMessageMaxBytes = 255; @@ -86,7 +86,7 @@ export interface ServiceBusMessageBatch { * * @readonly * @internal - * @ignore + * @hidden */ _generateMessage(): Buffer; @@ -94,7 +94,7 @@ export interface ServiceBusMessageBatch { * Gets the "message" span contexts that were created when adding events to the batch. * Used internally by the `sendBatch()` method to set up the right spans in traces if tracing is enabled. * @internal - * @ignore + * @hidden */ readonly _messageSpanContexts: SpanContext[]; } @@ -104,7 +104,7 @@ export interface ServiceBusMessageBatch { * * @class * @internal - * @ignore + * @hidden */ export class ServiceBusMessageBatchImpl implements ServiceBusMessageBatch { /** @@ -124,7 +124,7 @@ export class ServiceBusMessageBatchImpl implements ServiceBusMessageBatch { * Use the `createBatch()` method on your `Sender` instead. * @constructor * @internal - * @ignore + * @hidden */ constructor(private _context: ConnectionContext, private _maxSizeInBytes: number) { this._sizeInBytes = 0; @@ -159,7 +159,7 @@ export class ServiceBusMessageBatchImpl implements ServiceBusMessageBatch { /** * Gets the "message" span contexts that were created when adding messages to the batch. * @internal - * @ignore + * @hidden */ get _messageSpanContexts(): SpanContext[] { return this._spanContexts; diff --git a/sdk/servicebus/service-bus/src/servicebusSharedKeyCredential.ts b/sdk/servicebus/service-bus/src/servicebusSharedKeyCredential.ts index 1e52a6ea2a53..7a5e4854d6ee 100644 --- a/sdk/servicebus/service-bus/src/servicebusSharedKeyCredential.ts +++ b/sdk/servicebus/service-bus/src/servicebusSharedKeyCredential.ts @@ -10,7 +10,7 @@ import jssha from "jssha"; /** * @class SharedKeyCredential * @internal - * @ignore + * @hidden * Defines the SharedKeyCredential. */ export class SharedKeyCredential { @@ -99,7 +99,7 @@ export class SharedKeyCredential { * `SharedAccessSignature sr=&sig=&se=&skn=` * * @internal - * @ignore + * @hidden */ export class SharedAccessSignatureCredential extends SharedKeyCredential { private _accessToken: AccessToken; diff --git a/sdk/servicebus/service-bus/src/session/messageSession.ts b/sdk/servicebus/service-bus/src/session/messageSession.ts index 27593ab73927..49c7e6ed76cb 100644 --- a/sdk/servicebus/service-bus/src/session/messageSession.ts +++ b/sdk/servicebus/service-bus/src/session/messageSession.ts @@ -39,7 +39,7 @@ import { abandonMessage, completeMessage } from "../receivers/shared"; /** * Describes the options that need to be provided while creating a message session receiver link. * @internal - * @ignore + * @hidden */ export interface CreateMessageSessionReceiverLinkOptions { onClose: OnAmqpEventAsPromise; @@ -52,7 +52,7 @@ export interface CreateMessageSessionReceiverLinkOptions { /** * @internal - * @ignore + * @hidden * Describes all the options that can be set while instantiating a MessageSession object. */ export type MessageSessionOptions = Pick< @@ -64,7 +64,7 @@ export type MessageSessionOptions = Pick< /** * @internal - * @ignore + * @hidden * Describes the receiver for a Message Session. */ export class MessageSession extends LinkEntity { diff --git a/sdk/servicebus/service-bus/src/util/atomXmlHelper.ts b/sdk/servicebus/service-bus/src/util/atomXmlHelper.ts index 93efdd86522b..3b84f716d3d2 100644 --- a/sdk/servicebus/service-bus/src/util/atomXmlHelper.ts +++ b/sdk/servicebus/service-bus/src/util/atomXmlHelper.ts @@ -22,7 +22,7 @@ import { parseURL } from "./parseUrl"; /** * @internal - * @ignore + * @hidden * Represents the internal ATOM XML serializer interface */ export interface AtomXmlSerializer { @@ -33,7 +33,7 @@ export interface AtomXmlSerializer { /** * @internal - * @ignore + * @hidden * Utility to execute Atom XML operations as HTTP requests * @param webResource * @param serializer @@ -93,7 +93,7 @@ export async function executeAtomXmlOperation( /** * @internal - * @ignore + * @hidden * Serializes input information to construct the Atom XML request * @param resourceName Name of the resource to be serialized like `QueueDescription` * @param resource The entity details @@ -131,7 +131,7 @@ export function serializeToAtomXmlRequest(resourceName: string, resource: any): /** * @internal - * @ignore + * @hidden * Transforms response to contain the parsed data. * @param nameProperties The set of 'name' properties to be constructed on the * resultant object e.g., QueueName, TopicName, etc. @@ -154,7 +154,7 @@ export async function deserializeAtomXmlResponse( /** * @internal - * @ignore + * @hidden * Utility to deserialize the given JSON content in response body based on * if it's a single `entry` or `feed` and updates the `response.parsedBody` to hold the evaluated output. * @param response Response containing the JSON value in `response.parsedBody` @@ -203,7 +203,7 @@ function parseAtomResult(response: HttpOperationResponse, nameProperties: string /** * @internal - * @ignore + * @hidden * Utility to help parse given `entry` result * @param entry */ @@ -252,7 +252,7 @@ function parseEntryResult(entry: any): object | undefined { /** * @internal - * @ignore + * @hidden * Utility to help parse link info from the given `feed` result * @param feedLink */ @@ -273,7 +273,7 @@ function parseLinkInfo( /** * @internal - * @ignore + * @hidden * Utility to help parse given `feed` result * @param feed */ @@ -300,7 +300,7 @@ function parseFeedResult(feed: any): object[] & { nextLink?: string } { /** * @internal - * @ignore + * @hidden * @param {number} statusCode * @returns {statusCode is keyof typeof Constants.HttpResponseCodes} */ @@ -312,7 +312,7 @@ function isKnownResponseCode( /** * @internal - * @ignore + * @hidden * Extracts the applicable entity name(s) from the URL based on the known structure * and instantiates the corresponding name properties to the deserialized response * @@ -372,7 +372,7 @@ function setName(entry: any, nameProperties: any): any { /** * @internal - * @ignore + * @hidden * Utility to help construct the normalized `RestError` object based on given error * information and other data present in the received `response` object. * @param response @@ -419,7 +419,7 @@ export function buildError(response: HttpOperationResponse): RestError { /** * @internal - * @ignore + * @hidden * Helper utility to construct user friendly error codes based on based on given error * information and other data present in the received `response` object. * @param response diff --git a/sdk/servicebus/service-bus/src/util/constants.ts b/sdk/servicebus/service-bus/src/util/constants.ts index 98912afdce05..4f75e6e9ccf4 100644 --- a/sdk/servicebus/service-bus/src/util/constants.ts +++ b/sdk/servicebus/service-bus/src/util/constants.ts @@ -3,7 +3,7 @@ /** * @internal - * @ignore + * @hidden */ export const packageJsonInfo = { name: "@azure/service-bus", @@ -12,111 +12,111 @@ export const packageJsonInfo = { /** * @internal - * @ignore + * @hidden */ export const messageDispositionTimeout = 20000; /** * @internal - * @ignore + * @hidden */ export const max32BitNumber = Math.pow(2, 31) - 1; /** * Queue name identifier * @internal - * @ignore + * @hidden */ export const QUEUE_NAME = "QueueName"; /** * Topic name identifier * @internal - * @ignore + * @hidden */ export const TOPIC_NAME = "TopicName"; /** * Subscription name identifier * @internal - * @ignore + * @hidden */ export const SUBSCRIPTION_NAME = "SubscriptionName"; /** * Rule name identifier * @internal - * @ignore + * @hidden */ export const RULE_NAME = "RuleName"; /** * Accessed at field * @internal - * @ignore + * @hidden */ export const ACCESSED_AT = "AccessedAt"; /** * Updated at field * @internal - * @ignore + * @hidden */ export const UPDATED_AT = "UpdatedAt"; /** * Created at field * @internal - * @ignore + * @hidden */ export const CREATED_AT = "CreatedAt"; /** * Authorization rules on the entity * @internal - * @ignore + * @hidden */ export const AUTHORIZATION_RULES = "AuthorizationRules"; /** * Is Anonymous Accessible field * @internal - * @ignore + * @hidden */ export const IS_ANONYMOUS_ACCESSIBLE = "IsAnonymousAccessible"; /** * Entity Availability Status field * @internal - * @ignore + * @hidden */ export const ENTITY_AVAILABILITY_STATUS = "EntityAvailabilityStatus"; /** * Enable express option * @internal - * @ignore + * @hidden */ export const ENABLE_EXPRESS = "EnableExpress"; /** * Is express option * @internal - * @ignore + * @hidden */ export const IS_EXPRESS = "IsExpress"; /** * Enable Subscription Partitioning option * @internal - * @ignore + * @hidden */ export const ENABLE_SUBSCRIPTION_PARTITIONING = "EnableSubscriptionPartitioning"; /** * Filtering Messages Before Publishing option * @internal - * @ignore + * @hidden */ export const FILTER_MESSAGES_BEFORE_PUBLISHING = "FilteringMessagesBeforePublishing"; @@ -124,7 +124,7 @@ export const FILTER_MESSAGES_BEFORE_PUBLISHING = "FilteringMessagesBeforePublish * The entity's size in bytes. * * @internal - * @ignore + * @hidden */ export const SIZE_IN_BYTES = "SizeInBytes"; @@ -132,7 +132,7 @@ export const SIZE_IN_BYTES = "SizeInBytes"; * The entity's message count. * * @internal - * @ignore + * @hidden */ export const MESSAGE_COUNT = "MessageCount"; @@ -140,7 +140,7 @@ export const MESSAGE_COUNT = "MessageCount"; * The topic's subscription count. * * @internal - * @ignore + * @hidden */ export const SUBSCRIPTION_COUNT = "SubscriptionCount"; @@ -148,7 +148,7 @@ export const SUBSCRIPTION_COUNT = "SubscriptionCount"; * The topic / subscription's count details. * * @internal - * @ignore + * @hidden */ export const COUNT_DETAILS = "CountDetails"; @@ -156,7 +156,7 @@ export const COUNT_DETAILS = "CountDetails"; * The default rule name. * * @internal - * @ignore + * @hidden */ export const DEFAULT_RULE_NAME = "$Default"; @@ -164,7 +164,7 @@ export const DEFAULT_RULE_NAME = "$Default"; * Max idle time before entity is deleted. * This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds. * @internal - * @ignore + * @hidden */ export const AUTO_DELETE_ON_IDLE = "AutoDeleteOnIdle"; @@ -172,7 +172,7 @@ export const AUTO_DELETE_ON_IDLE = "AutoDeleteOnIdle"; * The status information on response * * @internal - * @ignore + * @hidden */ export const STATUS = "Status"; @@ -180,7 +180,7 @@ export const STATUS = "Status"; * The URL of Service Bus entity to forward messages to. * * @internal - * @ignore + * @hidden */ export const FORWARD_TO = "ForwardTo"; @@ -188,7 +188,7 @@ export const FORWARD_TO = "ForwardTo"; * The user meta data information * * @internal - * @ignore + * @hidden */ export const USER_METADATA = "UserMetadata"; @@ -196,7 +196,7 @@ export const USER_METADATA = "UserMetadata"; * The maximum size in megabytes. * * @internal - * @ignore + * @hidden */ export const MAX_SIZE_IN_MEGABYTES = "MaxSizeInMegabytes"; @@ -204,7 +204,7 @@ export const MAX_SIZE_IN_MEGABYTES = "MaxSizeInMegabytes"; * The default message time to live. * This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds. * @internal - * @ignore + * @hidden */ export const DEFAULT_MESSAGE_TIME_TO_LIVE = "DefaultMessageTimeToLive"; @@ -212,7 +212,7 @@ export const DEFAULT_MESSAGE_TIME_TO_LIVE = "DefaultMessageTimeToLive"; * The lock duration. * This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds. * @internal - * @ignore + * @hidden */ export const LOCK_DURATION = "LockDuration"; @@ -220,7 +220,7 @@ export const LOCK_DURATION = "LockDuration"; * The indication if session is required or not. * * @internal - * @ignore + * @hidden */ export const REQUIRES_SESSION = "RequiresSession"; @@ -228,7 +228,7 @@ export const REQUIRES_SESSION = "RequiresSession"; * The indication if duplicate detection is required or not. * * @internal - * @ignore + * @hidden */ export const REQUIRES_DUPLICATE_DETECTION = "RequiresDuplicateDetection"; @@ -239,7 +239,7 @@ export const REQUIRES_DUPLICATE_DETECTION = "RequiresDuplicateDetection"; * Settable only at entity creation time. * * @internal - * @ignore + * @hidden */ export const DEAD_LETTERING_ON_MESSAGE_EXPIRATION = "DeadLetteringOnMessageExpiration"; @@ -247,7 +247,7 @@ export const DEAD_LETTERING_ON_MESSAGE_EXPIRATION = "DeadLetteringOnMessageExpir * The indication if dead lettering on filter evaluation exceptions. * * @internal - * @ignore + * @hidden */ export const DEAD_LETTERING_ON_FILTER_EVALUATION_EXCEPTIONS = "DeadLetteringOnFilterEvaluationExceptions"; @@ -256,7 +256,7 @@ export const DEAD_LETTERING_ON_FILTER_EVALUATION_EXCEPTIONS = * The history time window for duplicate detection. * This is specified in ISO-8601 duration format such as "PT1M" for 1 minute, "PT5S" for 5 seconds. * @internal - * @ignore + * @hidden */ export const DUPLICATE_DETECTION_HISTORY_TIME_WINDOW = "DuplicateDetectionHistoryTimeWindow"; @@ -264,7 +264,7 @@ export const DUPLICATE_DETECTION_HISTORY_TIME_WINDOW = "DuplicateDetectionHistor * The maximum delivery count of messages after which if it is still not settled, gets moved to the dead-letter sub-queue. * * @internal - * @ignore + * @hidden */ export const MAX_DELIVERY_COUNT = "MaxDeliveryCount"; @@ -272,7 +272,7 @@ export const MAX_DELIVERY_COUNT = "MaxDeliveryCount"; * Indicates if the queue has enabled batch operations. * * @internal - * @ignore + * @hidden */ export const ENABLE_BATCHED_OPERATIONS = "EnableBatchedOperations"; @@ -280,7 +280,7 @@ export const ENABLE_BATCHED_OPERATIONS = "EnableBatchedOperations"; * Indicates whether the topic can be ordered * * @internal - * @ignore + * @hidden */ export const SUPPORT_ORDERING = "SupportOrdering"; @@ -288,7 +288,7 @@ export const SUPPORT_ORDERING = "SupportOrdering"; * Indicates whether the topic/queue should be split across multiple partitions * * @internal - * @ignore + * @hidden */ export const ENABLE_PARTITIONING = "EnablePartitioning"; @@ -296,7 +296,7 @@ export const ENABLE_PARTITIONING = "EnablePartitioning"; * The URL of Service Bus entity to forward deadlettered messages to. * * @internal - * @ignore + * @hidden */ export const FORWARD_DEADLETTERED_MESSAGES_TO = "ForwardDeadLetteredMessagesTo"; @@ -304,7 +304,7 @@ export const FORWARD_DEADLETTERED_MESSAGES_TO = "ForwardDeadLetteredMessagesTo"; * Query string parameter to set Service Bus API version * * @internal - * @ignore + * @hidden */ export const API_VERSION_QUERY_KEY = "api-version"; @@ -312,7 +312,7 @@ export const API_VERSION_QUERY_KEY = "api-version"; * Current API version being sent to service bus * * @internal - * @ignore + * @hidden */ export const CURRENT_API_VERSION = "2017-04"; @@ -320,14 +320,14 @@ export const CURRENT_API_VERSION = "2017-04"; * Constant representing the Odata Error 'message' property * * @internal - * @ignore + * @hidden */ export const ODATA_ERROR_MESSAGE = "message"; /** * Constant representing the 'value' property of Odata Error 'message' property * * @internal - * @ignore + * @hidden */ export const ODATA_ERROR_MESSAGE_VALUE = "value"; @@ -335,7 +335,7 @@ export const ODATA_ERROR_MESSAGE_VALUE = "value"; * Marker for atom metadata. * * @internal - * @ignore + * @hidden */ export const XML_METADATA_MARKER = "$"; @@ -343,7 +343,7 @@ export const XML_METADATA_MARKER = "$"; * Marker for atom value. * * @internal - * @ignore + * @hidden */ export const XML_VALUE_MARKER = "_"; @@ -351,7 +351,7 @@ export const XML_VALUE_MARKER = "_"; * Constant representing the property where the atom default elements are stored. * * @internal - * @ignore + * @hidden */ export const ATOM_METADATA_MARKER = "_"; @@ -359,7 +359,7 @@ export const ATOM_METADATA_MARKER = "_"; * Known HTTP status codes as documented and referenced in ATOM based management API feature * https://docs.microsoft.com/dotnet/api/system.net.httpstatuscode?view=netframework-4.8 * @internal - * @ignore + * @hidden */ export const HttpResponseCodes = { 100: "Continue", diff --git a/sdk/servicebus/service-bus/src/util/crypto.browser.ts b/sdk/servicebus/service-bus/src/util/crypto.browser.ts index 6caaef03c20d..b69fa880c066 100644 --- a/sdk/servicebus/service-bus/src/util/crypto.browser.ts +++ b/sdk/servicebus/service-bus/src/util/crypto.browser.ts @@ -6,7 +6,7 @@ /** * @internal - * @ignore + * @hidden * @param {string} secret * @param {string} stringToSign * @returns {Promise} @@ -31,7 +31,7 @@ export async function generateKey(secret: string, stringToSign: string): Promise /** * @internal - * @ignore + * @hidden * @param {string} value */ function convertToUint8Array(value: string) { @@ -46,7 +46,7 @@ function convertToUint8Array(value: string) { * Encodes a byte array in base64 format. * @param value the Uint8Aray to encode * @internal - * @ignore + * @hidden * @param {Uint8Array} value * @returns {string} */ diff --git a/sdk/servicebus/service-bus/src/util/crypto.ts b/sdk/servicebus/service-bus/src/util/crypto.ts index 8f7df4159404..538889a2b703 100644 --- a/sdk/servicebus/service-bus/src/util/crypto.ts +++ b/sdk/servicebus/service-bus/src/util/crypto.ts @@ -8,7 +8,7 @@ import crypto from "crypto"; /** * @internal - * @ignore + * @hidden */ export async function generateKey(secret: string, stringToSign: string) { const result = encodeURIComponent( diff --git a/sdk/servicebus/service-bus/src/util/errors.ts b/sdk/servicebus/service-bus/src/util/errors.ts index eaecf3cb26bb..0d82e90fbda0 100644 --- a/sdk/servicebus/service-bus/src/util/errors.ts +++ b/sdk/servicebus/service-bus/src/util/errors.ts @@ -13,7 +13,7 @@ import { ReceiveMode } from "../models"; * senders and receivers. * * @internal - * @ignore + * @hidden */ export const entityPathMisMatchError = "The queue or topic name provided does not match the EntityPath in the connection string passed to the ServiceBusClient constructor."; @@ -22,13 +22,13 @@ export const entityPathMisMatchError = * Error message for when maxMessageCount provided is invalid. * * @internal - * @ignore + * @hidden */ export const InvalidMaxMessageCountError = "'maxMessageCount' must be a number greater than 0."; /** * @internal - * @ignore + * @hidden * Logs and throws Error if the current AMQP connection is closed. * @param context The ConnectionContext associated with the current AMQP connection. */ @@ -43,7 +43,7 @@ export function throwErrorIfConnectionClosed(context: ConnectionContext): void { /** * @internal - * @ignore + * @hidden * Gets the error message when a sender is used when its already closed * @param entityPath Value of the `entityPath` property on the client which denotes its name */ @@ -56,7 +56,7 @@ export function getSenderClosedErrorMsg(entityPath: string): string { /** * @internal - * @ignore + * @hidden * Gets the error message when a receiver is used when its already closed * @param entityPath Value of the `entityPath` property on the client which denotes its name * @param sessionId If using session receiver, then the id of the session @@ -76,7 +76,7 @@ export function getReceiverClosedErrorMsg(entityPath: string, sessionId?: string /** * @internal - * @ignore + * @hidden * @param entityPath Value of the `entityPath` property on the client which denotes its name * @param sessionId If using session receiver, then the id of the session */ @@ -89,7 +89,7 @@ export function getAlreadyReceivingErrorMsg(entityPath: string, sessionId?: stri /** * @internal - * @ignore + * @hidden * Logs and Throws TypeError if given parameter is undefined or null * @param connectionId Id of the underlying AMQP connection used for logging * @param parameterName Name of the parameter to check @@ -109,7 +109,7 @@ export function throwTypeErrorIfParameterMissing( /** * @internal - * @ignore + * @hidden * Logs and Throws TypeError if given parameter is not of expected type * @param connectionId Id of the underlying AMQP connection used for logging * @param parameterName Name of the parameter to type check @@ -134,7 +134,7 @@ export function throwTypeErrorIfParameterTypeMismatch( /** * @internal - * @ignore + * @hidden * Logs and Throws TypeError if given parameter is not of type `Long` or an array of type `Long` * @param connectionId Id of the underlying AMQP connection used for logging * @param parameterName Name of the parameter to type check @@ -158,7 +158,7 @@ export function throwTypeErrorIfParameterNotLong( /** * @internal - * @ignore + * @hidden * Logs and Throws TypeError if given parameter is not an array of type `Long` * @param connectionId Id of the underlying AMQP connection used for logging * @param parameterName Name of the parameter to type check @@ -179,7 +179,7 @@ export function throwTypeErrorIfParameterNotLongArray( /** * @internal - * @ignore + * @hidden * Logs and Throws TypeError if given parameter is an empty string * @param connectionId Id of the underlying AMQP connection used for logging * @param parameterName Name of the parameter to type check @@ -200,7 +200,7 @@ export function throwTypeErrorIfParameterIsEmptyString( /** * @internal - * @ignore + * @hidden * The error message for operations on the receiver that are invalid for a message received in receiveAndDelete mode. */ export const InvalidOperationInReceiveAndDeleteMode = @@ -208,7 +208,7 @@ export const InvalidOperationInReceiveAndDeleteMode = /** * @internal - * @ignore + * @hidden * The error message for operations on the receiver that are invalid for a peeked message. */ export const InvalidOperationForPeekedMessage = @@ -216,7 +216,7 @@ export const InvalidOperationForPeekedMessage = /** * @internal - * @ignore + * @hidden * The error message for when one attempts to settle an already settled message. */ export const MessageAlreadySettled = "The message has either been deleted or already settled"; @@ -224,7 +224,7 @@ export const MessageAlreadySettled = "The message has either been deleted or alr /** * Throws error if the ServiceBusReceivedMessage cannot be settled. * @internal - * @ignore + * @hidden */ export function throwErrorIfInvalidOperationOnMessage( message: ServiceBusReceivedMessage, @@ -254,7 +254,7 @@ export function throwErrorIfInvalidOperationOnMessage( * Error message for when the ServiceBusMessage provided by the user has different values * for partitionKey and sessionId. * @internal - * @ignore + * @hidden * @throw */ export const PartitionKeySessionIdMismatchError = @@ -262,7 +262,7 @@ export const PartitionKeySessionIdMismatchError = /** * Throws error if the given object is not a valid ServiceBusMessage * @internal - * @ignore + * @hidden * @param msg The object that needs to be validated as a ServiceBusMessage * @param errorMessageForWrongType The error message to use when given object is not a ServiceBusMessage */ diff --git a/sdk/servicebus/service-bus/src/util/parseUrl.browser.ts b/sdk/servicebus/service-bus/src/util/parseUrl.browser.ts index 6ca75d1027fb..8588797c2c52 100644 --- a/sdk/servicebus/service-bus/src/util/parseUrl.browser.ts +++ b/sdk/servicebus/service-bus/src/util/parseUrl.browser.ts @@ -6,7 +6,7 @@ /** * @internal - * @ignore + * @hidden * @param {string} rawUrl */ export const parseURL = (rawUrl: string): any => { diff --git a/sdk/servicebus/service-bus/src/util/parseUrl.ts b/sdk/servicebus/service-bus/src/util/parseUrl.ts index f3b618c75ea5..4b7df9c705c7 100644 --- a/sdk/servicebus/service-bus/src/util/parseUrl.ts +++ b/sdk/servicebus/service-bus/src/util/parseUrl.ts @@ -6,13 +6,13 @@ /** * @internal - * @ignore + * @hidden */ const url = require("url"); /** * @internal - * @ignore + * @hidden * @param {string} rawUrl */ export const parseURL = (rawUrl: string) => { diff --git a/sdk/servicebus/service-bus/src/util/runtimeInfo.browser.ts b/sdk/servicebus/service-bus/src/util/runtimeInfo.browser.ts index 8fbc0068437d..d87f1c50b448 100644 --- a/sdk/servicebus/service-bus/src/util/runtimeInfo.browser.ts +++ b/sdk/servicebus/service-bus/src/util/runtimeInfo.browser.ts @@ -3,7 +3,7 @@ /** * @internal - * @ignore + * @hidden */ interface NavigatorEx extends Navigator { // oscpu is not yet standards-compliant, but can not be undefined in TypeScript 3.6.2 @@ -12,7 +12,7 @@ interface NavigatorEx extends Navigator { /** * Returns information about the platform this function is being run on. - * @ignore + * @hidden * @internal */ export function getRuntimeInfo(): string { diff --git a/sdk/servicebus/service-bus/src/util/runtimeInfo.ts b/sdk/servicebus/service-bus/src/util/runtimeInfo.ts index e3501630ba62..b482be6774fe 100644 --- a/sdk/servicebus/service-bus/src/util/runtimeInfo.ts +++ b/sdk/servicebus/service-bus/src/util/runtimeInfo.ts @@ -5,7 +5,7 @@ import * as os from "os"; /** * Returns information about the platform this function is being run on. - * @ignore + * @hidden * @internal */ export function getRuntimeInfo(): string { diff --git a/sdk/servicebus/service-bus/src/util/sasServiceClientCredentials.ts b/sdk/servicebus/service-bus/src/util/sasServiceClientCredentials.ts index 2a65d44c9068..02596332a6ce 100644 --- a/sdk/servicebus/service-bus/src/util/sasServiceClientCredentials.ts +++ b/sdk/servicebus/service-bus/src/util/sasServiceClientCredentials.ts @@ -11,7 +11,7 @@ import { generateKey } from "./crypto"; /** * @internal - * @ignore + * @hidden * @class SasServiceClientCredentials * @implements {ServiceClientCredentials} */ diff --git a/sdk/servicebus/service-bus/src/util/semaphore.ts b/sdk/servicebus/service-bus/src/util/semaphore.ts index b14a764ac995..9da75029259f 100644 --- a/sdk/servicebus/service-bus/src/util/semaphore.ts +++ b/sdk/servicebus/service-bus/src/util/semaphore.ts @@ -3,7 +3,7 @@ /** * @internal - * @ignore + * @hidden * A simple Semaphore * @class Semaphore */ diff --git a/sdk/servicebus/service-bus/src/util/tracing.ts b/sdk/servicebus/service-bus/src/util/tracing.ts index 1d7705e48e4e..3b56ee37f898 100644 --- a/sdk/servicebus/service-bus/src/util/tracing.ts +++ b/sdk/servicebus/service-bus/src/util/tracing.ts @@ -7,7 +7,7 @@ import { CanonicalCode, Span, SpanKind, SpanOptions as OTSpanOptions } from "@op /** * @internal - * @ignore + * @hidden * Creates a span using the global tracer. * @param name The name of the operation being performed. * @param operationOptions The options for the underlying http request. @@ -48,7 +48,7 @@ export function createSpan( /** * @internal - * @ignore + * @hidden */ export function getCanonicalCode(err: Error) { if (err instanceof RestError) { diff --git a/sdk/servicebus/service-bus/src/util/utils.ts b/sdk/servicebus/service-bus/src/util/utils.ts index 0b4211b008d0..c04e8d95143a 100644 --- a/sdk/servicebus/service-bus/src/util/utils.ts +++ b/sdk/servicebus/service-bus/src/util/utils.ts @@ -13,21 +13,21 @@ import { HttpOperationResponse, HttpResponse, isNode } from "@azure/core-http"; // This is the only dependency we have on DOM types, so rather than require // the DOM lib we can just shim this in. /** - * @ignore + * @hidden * @internal */ interface Navigator { hardwareConcurrency: number; } /** - * @ignore + * @hidden * @internal */ declare const navigator: Navigator; /** * @internal - * @ignore + * @hidden * Provides a uniue name by appending a string guid to the given string in the following format: * `{name}-{uuid}`. * @param name The nme of the entity @@ -38,7 +38,7 @@ export function getUniqueName(name: string): string { /** * @internal - * @ignore + * @hidden * If you try to turn a Guid into a Buffer in .NET, the bytes of the first three groups get * flipped within the group, but the last two groups don't get flipped, so we end up with a * different byte order. This is the order of bytes needed to make Service Bus recognize the token. @@ -77,7 +77,7 @@ export function reorderLockToken(lockTokenBytes: Buffer): Buffer { /** * @internal - * @ignore + * @hidden * Provides the time in milliseconds after which the lock renewal should occur. * @param lockedUntilUtc - The time until which the message is locked. */ @@ -99,7 +99,7 @@ export function calculateRenewAfterDuration(lockedUntilUtc: Date): number { /** * @internal - * @ignore + * @hidden * Converts the .net ticks to a JS Date object. * * - The epoch for the DateTimeOffset type is `0000-01-01`, while the epoch for JS Dates is @@ -126,7 +126,7 @@ export function convertTicksToDate(buf: number[]): Date { /** * @internal - * @ignore + * @hidden * Returns the number of logical processors in the system. */ export function getProcessorCount(): number { @@ -140,7 +140,7 @@ export function getProcessorCount(): number { /** * @internal - * @ignore + * @hidden * Converts any given input to a Buffer. * @param input The input that needs to be converted to a Buffer. */ @@ -175,7 +175,7 @@ export function toBuffer(input: any): Buffer { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve `string` value from given string, * or throws error if undefined. * @param value @@ -192,7 +192,7 @@ export function getString(value: any, nameOfProperty: string): string { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve `string` value from given input, * or undefined if not passed in. * @param value @@ -206,7 +206,7 @@ export function getStringOrUndefined(value: any): string | undefined { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve `integer` value from given string, * or throws error if undefined. * @param value @@ -223,7 +223,7 @@ export function getInteger(value: any, nameOfProperty: string): number { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve `integer` value from given string, * or undefined if not passed in. * @param value @@ -238,7 +238,7 @@ export function getIntegerOrUndefined(value: any): number | undefined { /** * @internal - * @ignore + * @hidden * Helper utility to convert ISO-8601 time into Date type. * @param value */ @@ -248,7 +248,7 @@ export function getDate(value: string, nameOfProperty: string): Date { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve `boolean` value from given string, * or throws error if undefined. * @param value @@ -265,7 +265,7 @@ export function getBoolean(value: any, nameOfProperty: string): boolean { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve `boolean` value from given string, * or undefined if not passed in. * @param value @@ -284,7 +284,7 @@ export function getBooleanOrUndefined(value: any): boolean | undefined { /** * @internal - * @ignore + * @hidden * Returns `true` if given input is a JSON like object. * @param value */ @@ -294,7 +294,7 @@ export function isJSONLikeObject(value: any): boolean { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve message count details from given input, * @param value */ @@ -314,7 +314,7 @@ export function getMessageCountDetails(value: any): MessageCountDetails { /** * Represents type of message count details in ATOM based management operations. * @internal - * @ignore + * @hidden */ export type MessageCountDetails = { activeMessageCount: number; @@ -352,7 +352,7 @@ export interface AuthorizationRule { /** * @internal - * @ignore + * @hidden * Helper utility to retrieve array of `AuthorizationRule` from given input, * or undefined if not passed in. * @param value @@ -382,7 +382,7 @@ export function getAuthorizationRulesOrUndefined(value: any): AuthorizationRule[ /** * @internal - * @ignore + * @hidden * Helper utility to build an instance of parsed authorization rule as `AuthorizationRule` from given input. * @param value */ @@ -408,7 +408,7 @@ function buildAuthorizationRule(value: any): AuthorizationRule { /** * @internal - * @ignore + * @hidden * Helper utility to extract output containing array of `RawAuthorizationRule` instances from given input, * or undefined if not passed in. * @param value @@ -437,7 +437,7 @@ export function getRawAuthorizationRules(authorizationRules: AuthorizationRule[] /** * @internal - * @ignore + * @hidden * Helper utility to build an instance of raw authorization rule as RawAuthorizationRule from given `AuthorizationRule` input. * @param authorizationRule parsed Authorization Rule instance */ @@ -472,7 +472,7 @@ function buildRawAuthorizationRule(authorizationRule: AuthorizationRule): any { /** * @internal - * @ignore + * @hidden * Helper utility to check if given string is an absolute URL * @param url */ @@ -507,7 +507,7 @@ export type EntityAvailabilityStatus = /** * @internal - * @ignore + * @hidden */ export const StandardAbortMessage = "The operation was aborted."; @@ -522,7 +522,7 @@ export const StandardAbortMessage = "The operation was aborted."; * @returns {Promise} - Resolved promise * * @internal - * @ignore + * @hidden */ export async function waitForTimeoutOrAbortOrResolve(args: { actionFn: () => Promise; @@ -576,7 +576,7 @@ export async function waitForTimeoutOrAbortOrResolve(args: { * the abortSignal was not defined. * * @internal - * @ignore + * @hidden */ export function checkAndRegisterWithAbortSignal( onAbortFn: (abortError: AbortError) => void, @@ -602,7 +602,7 @@ export function checkAndRegisterWithAbortSignal( /** * @internal - * @ignore + * @hidden * @property {string} libInfo The user agent prefix string for the ServiceBus client. * See guideline at https://azure.github.io/azure-sdk/general_azurecore.html#telemetry-policy */ @@ -610,7 +610,7 @@ export const libInfo: string = `azsdk-js-azureservicebus/${Constants.packageJson /** * @internal - * @ignore + * @hidden * Returns the formatted prefix by removing the spaces, by appending the libInfo. * * @param {string} [prefix] @@ -624,7 +624,7 @@ export function formatUserAgentPrefix(prefix?: string): string { /** * @internal - * @ignore + * @hidden * Helper method which returns `HttpResponse` from an object of shape `HttpOperationResponse`. * @returns {HttpResponse} */ diff --git a/sdk/servicebus/service-bus/tsdoc.json b/sdk/servicebus/service-bus/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/servicebus/service-bus/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/storage/storage-blob-changefeed/tsdoc.json b/sdk/storage/storage-blob-changefeed/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/storage/storage-blob-changefeed/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/storage/storage-blob/src/StorageClient.ts b/sdk/storage/storage-blob/src/StorageClient.ts index ac0fe2d9bb8b..5d8dff5bc4d5 100644 --- a/sdk/storage/storage-blob/src/StorageClient.ts +++ b/sdk/storage/storage-blob/src/StorageClient.ts @@ -39,7 +39,7 @@ export abstract class StorageClient { * Request policy pipeline. * * @internal - * @ignore + * @hidden * @type {Pipeline} * @memberof StorageClient */ diff --git a/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts index 8e282f50ca8e..aab93122ce4c 100644 --- a/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-blob/src/TelemetryPolicyFactory.ts @@ -23,7 +23,7 @@ import { SDK_VERSION } from "./utils/constants"; export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * @internal - * @ignore + * @hidden */ public readonly telemetryString: string; diff --git a/sdk/storage/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.ts b/sdk/storage/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.ts index 424f40049776..27e2ebacaca5 100644 --- a/sdk/storage/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.ts +++ b/sdk/storage/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.ts @@ -52,7 +52,7 @@ export interface BlobBeginCopyFromUrlPollState * - performing the initial startCopyFromURL * - checking the copy status via getProperties * - cancellation via abortCopyFromURL - * @ignore + * @hidden */ export interface BlobBeginCopyFromURLPollOperation extends PollOperation {} @@ -61,7 +61,7 @@ export interface BlobBeginCopyFromURLPollOperation * The set of options used to configure the poller. * This is an internal interface populated by {@link BlobClient.beginCopyFromURL}. * - * @ignore + * @hidden */ export interface BlobBeginCopyFromUrlPollerOptions { blobClient: CopyPollerBlobClient; @@ -76,7 +76,7 @@ export interface BlobBeginCopyFromUrlPollerOptions { * This is the poller returned by {@link BlobClient.beginCopyFromURL}. * This can not be instantiated directly outside of this package. * - * @ignore + * @hidden */ export class BlobBeginCopyFromUrlPoller extends Poller< BlobBeginCopyFromUrlPollState, @@ -125,7 +125,7 @@ export class BlobBeginCopyFromUrlPoller extends Poller< * Note: Intentionally using function expression over arrow function expression * so that the function can be invoked with a different context. * This affects what `this` refers to. - * @ignore + * @hidden */ const cancel: BlobBeginCopyFromURLPollOperation["cancel"] = async function cancel( this: BlobBeginCopyFromURLPollOperation, @@ -155,7 +155,7 @@ const cancel: BlobBeginCopyFromURLPollOperation["cancel"] = async function cance * Note: Intentionally using function expression over arrow function expression * so that the function can be invoked with a different context. * This affects what `this` refers to. - * @ignore + * @hidden */ const update: BlobBeginCopyFromURLPollOperation["update"] = async function update( this: BlobBeginCopyFromURLPollOperation, @@ -211,7 +211,7 @@ const update: BlobBeginCopyFromURLPollOperation["update"] = async function updat * Note: Intentionally using function expression over arrow function expression * so that the function can be invoked with a different context. * This affects what `this` refers to. - * @ignore + * @hidden */ const toString: BlobBeginCopyFromURLPollOperation["toString"] = function toString( this: BlobBeginCopyFromURLPollOperation @@ -227,7 +227,7 @@ const toString: BlobBeginCopyFromURLPollOperation["toString"] = function toStrin /** * Creates a poll operation given the provided state. - * @ignore + * @hidden */ function makeBlobBeginCopyFromURLPollOperation( state: BlobBeginCopyFromUrlPollState diff --git a/sdk/storage/storage-blob/tsdoc.json b/sdk/storage/storage-blob/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/storage/storage-blob/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/storage/storage-datalake/tsdoc.json b/sdk/storage/storage-datalake/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/storage/storage-datalake/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/storage/storage-file-datalake/src/StorageClient.ts b/sdk/storage/storage-file-datalake/src/StorageClient.ts index 612b82577f73..ea45d976c122 100644 --- a/sdk/storage/storage-file-datalake/src/StorageClient.ts +++ b/sdk/storage/storage-file-datalake/src/StorageClient.ts @@ -58,7 +58,7 @@ export abstract class StorageClient { * Request policy pipeline. * * @internal - * @ignore + * @hidden * @type {Pipeline} * @memberof StorageClient */ diff --git a/sdk/storage/storage-file-datalake/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-file-datalake/src/TelemetryPolicyFactory.ts index 37d8ffcb0001..886c2e1be1d7 100644 --- a/sdk/storage/storage-file-datalake/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-file-datalake/src/TelemetryPolicyFactory.ts @@ -23,7 +23,7 @@ import { SDK_VERSION } from "./utils/constants"; export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * @internal - * @ignore + * @hidden */ public readonly telemetryString: string; diff --git a/sdk/storage/storage-file-share/src/StorageClient.ts b/sdk/storage/storage-file-share/src/StorageClient.ts index 77aabec5bafe..ddc4b3b46d45 100644 --- a/sdk/storage/storage-file-share/src/StorageClient.ts +++ b/sdk/storage/storage-file-share/src/StorageClient.ts @@ -38,7 +38,7 @@ export abstract class StorageClient { * Request policy pipeline. * * @internal - * @ignore + * @hidden * @type {Pipeline} * @memberof StorageClient */ @@ -49,7 +49,7 @@ export abstract class StorageClient { * Initialized to an AnonymousCredential if not able to retrieve it from the pipeline. * * @internal - * @ignore + * @hidden * @type {Credential} * @memberof StorageClient */ diff --git a/sdk/storage/storage-file-share/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-file-share/src/TelemetryPolicyFactory.ts index d09af7419175..4c873c1f4d9b 100644 --- a/sdk/storage/storage-file-share/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-file-share/src/TelemetryPolicyFactory.ts @@ -23,7 +23,7 @@ import { SDK_VERSION } from "./utils/constants"; export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * @internal - * @ignore + * @hidden */ public readonly telemetryString: string; diff --git a/sdk/storage/storage-file-share/tsdoc.json b/sdk/storage/storage-file-share/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/storage/storage-file-share/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/storage/storage-queue/src/StorageClient.ts b/sdk/storage/storage-queue/src/StorageClient.ts index 0a6ad154ad20..040a061bb15d 100644 --- a/sdk/storage/storage-queue/src/StorageClient.ts +++ b/sdk/storage/storage-queue/src/StorageClient.ts @@ -40,7 +40,7 @@ export abstract class StorageClient { * Request policy pipeline. * * @internal - * @ignore + * @hidden * @type {Pipeline} * @memberof StorageClient */ @@ -51,7 +51,7 @@ export abstract class StorageClient { * Initialized to an AnonymousCredential if not able to retrieve it from the pipeline. * * @internal - * @ignore + * @hidden * @type {Credential} * @memberof StorageClient */ diff --git a/sdk/storage/storage-queue/src/TelemetryPolicyFactory.ts b/sdk/storage/storage-queue/src/TelemetryPolicyFactory.ts index 0ac20a43e4b4..571b52099614 100644 --- a/sdk/storage/storage-queue/src/TelemetryPolicyFactory.ts +++ b/sdk/storage/storage-queue/src/TelemetryPolicyFactory.ts @@ -23,7 +23,7 @@ import { SDK_VERSION } from "./utils/constants"; export class TelemetryPolicyFactory implements RequestPolicyFactory { /** * @internal - * @ignore + * @hidden */ public readonly telemetryString: string; diff --git a/sdk/storage/storage-queue/tsdoc.json b/sdk/storage/storage-queue/tsdoc.json new file mode 100644 index 000000000000..81c5a8a2aa2f --- /dev/null +++ b/sdk/storage/storage-queue/tsdoc.json @@ -0,0 +1,4 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "extends": ["../../../tsdoc.json"] +}