diff --git a/sdk/servicebus/service-bus/README.md b/sdk/servicebus/service-bus/README.md index 4d74bdf7c44e..64964328fe67 100644 --- a/sdk/servicebus/service-bus/README.md +++ b/sdk/servicebus/service-bus/README.md @@ -8,7 +8,7 @@ Use the client library `@azure/service-bus` in your application to - Receive messages from an Azure Service Bus Queue or Subscription - Create/Get/Delete/Update/List Queues/Topics/Subscriptions/Rules in an Azure Service Bus namespace. -Resources for the v7.0.0-preview.7 of `@azure/service-bus`: +Resources for the v7.0.0-preview.8 of `@azure/service-bus`: [Source code](https://github.com/Azure/azure-sdk-for-js/tree/master/sdk/servicebus/service-bus) | [Package (npm)](https://www.npmjs.com/package/@azure/service-bus) | diff --git a/sdk/servicebus/service-bus/migrationguide.md b/sdk/servicebus/service-bus/migrationguide.md index 46cb950bcc87..267062a0cba5 100644 --- a/sdk/servicebus/service-bus/migrationguide.md +++ b/sdk/servicebus/service-bus/migrationguide.md @@ -1,6 +1,6 @@ -# Guide to migrate from @azure/service-bus v1 to v7.preview.7 +# Guide to migrate from @azure/service-bus v1 to v7.preview.8 -This document is intended for users that would like to try out preview 7 +This document is intended for users that would like to try out preview 8 for @azure/service-bus. As the package is in preview, these details might change as the package is developed before its final release. diff --git a/sdk/servicebus/service-bus/src/modelsToBeSharedWithEventHubs.ts b/sdk/servicebus/service-bus/src/modelsToBeSharedWithEventHubs.ts index 8e4cc931df0b..8661ce4bf42f 100644 --- a/sdk/servicebus/service-bus/src/modelsToBeSharedWithEventHubs.ts +++ b/sdk/servicebus/service-bus/src/modelsToBeSharedWithEventHubs.ts @@ -24,6 +24,15 @@ export function getParentSpan( return options?.spanOptions?.parent; } +/** + * @internal + * @ignore + * + * @param {(Span | SpanContext | null)} [parentSpan] + * @param {SpanContext[]} [spanContextsToLink=[]] + * @param {string} [entityPath] + * @param {string} [host] + */ export function createSendSpan( parentSpan?: Span | SpanContext | null, spanContextsToLink: SpanContext[] = [], diff --git a/sdk/servicebus/service-bus/src/receivers/shared.ts b/sdk/servicebus/service-bus/src/receivers/shared.ts index 33a2a3e2227b..f627b4736a94 100644 --- a/sdk/servicebus/service-bus/src/receivers/shared.ts +++ b/sdk/servicebus/service-bus/src/receivers/shared.ts @@ -70,6 +70,14 @@ export function wrapProcessErrorHandler( }; } +/** + * @internal + * @ignore + * + * @param {ServiceBusMessageImpl} message + * @param {ConnectionContext} context + * @param {string} entityPath + */ export function completeMessage( message: ServiceBusMessageImpl, context: ConnectionContext, @@ -83,6 +91,15 @@ export function completeMessage( return settleMessage(message, DispositionType.complete, context, entityPath); } +/** + * @internal + * @ignore + * + * @param {ServiceBusMessageImpl} message + * @param {ConnectionContext} context + * @param {string} entityPath + * @param {{ [key: string]: any }} [propertiesToModify] + */ export function abandonMessage( message: ServiceBusMessageImpl, context: ConnectionContext, @@ -99,6 +116,15 @@ export function abandonMessage( }); } +/** + * @internal + * @ignore + * + * @param {ServiceBusMessageImpl} message + * @param {ConnectionContext} context + * @param {string} entityPath + * @param {{ [key: string]: any }} [propertiesToModify] + */ export function deferMessage( message: ServiceBusMessageImpl, context: ConnectionContext, @@ -115,6 +141,15 @@ export function deferMessage( }); } +/** + * @internal + * @ignore + * + * @param {ServiceBusMessageImpl} message + * @param {ConnectionContext} context + * @param {string} entityPath + * @param {(DeadLetterOptions & { [key: string]: any })} [propertiesToModify] + */ export function deadLetterMessage( message: ServiceBusMessageImpl, context: ConnectionContext, @@ -150,6 +185,16 @@ export function deadLetterMessage( ); } +/** + * @internal + * @ignore + * + * @param {ServiceBusMessageImpl} message + * @param {DispositionType} operation + * @param {ConnectionContext} context + * @param {string} entityPath + * @param {DispositionStatusOptions} [options] + */ function settleMessage( message: ServiceBusMessageImpl, operation: DispositionType,