Azure/azure-sdk-for-js @azure/storage-queue_12.0.0-preview.5

on GitHub

2019.10 12.0.0-preview.5

• [Breaking] Major API changes for the @azure/storage-queue package.
  • Flattened Client Hierarchy - QueueClient is flattened into QueueServiceClient, MesagesClient is renamed to QueueClient, MessageIdClient is flattened into the new QueueClient. PR #5579
    • enqueueMessage is renamed as sendMessage, dequeueMessages is renamed to receiveMessages
    • The new QueueServiceClient has createQueue and deleteQueue helper methods.
    • Names of Options and Responses as per the new hierarchy of clients. PR #5617
      • Example - MessagesClearOptions is renamed to QueueClearMessagesOptions, MessagesEnqueueResponse is renamed to QueueSendMessageResponse.
    • DequeuedMessageItem is renamed to ReceivedMessageItem PR #5661
• Created new interface CommonOptions. This interface is for standard options that apply to all methods that invoke remote operations. This interface currently contains options that enable client-side tracing of the SDK. PR #5550
• [Breaking] IPRange is renamed to SasIPRange. PR #5551
• [Breaking] Models is no longer exported in public API surface. Instead generated model types required by the public API are explicitly re-exported and aliased with Model suffix.
  For example, after this change, Models.QueueItem becomes QueueItemModel. PR #5534
• [Breaking] Cancelling an operation now throws a standardized error with the name AbortError. PR #5633
• [Breaking] queueName on QueueClient is renamed to name. PR #5613
• [Breaking] body field from RestError Object in core-http Library is removed, the response property on the error will now have the parsedBody & headers along with raw body & headers that are already present. PRs #5670, #5437
  • Errors from the storage service can be seen in an extra field details with the expected error code. #5688
• [Breaking] Type of the permissions attribute in the options bag FileSASSignatureValues to be passed into generateQueueSASQueryParameters is changed to QueueSASPermissions from type string. PR #5626
  • Similarly, AccountSASPermissions for generateAccountSASQueryParameters instead of type string.
  • Example - permissions attribute in generateQueueSASQueryParameters
    • permissions: QueueSASPermissions.parse("racwd").toString() changes to QueueSASPermissions.parse("racwd")
• [Breaking] Appropriate attribute renames in all the interfaces PR #5629
  • Example - nextMarker -> continuationToken, HTTPClient -> HttpClient, permission -> permissions
• Bug fix - Name properties on clients now support the Emulator. PR #5557
  • emulator url when the queueEndpoint is http://127.0.0.1:10001/devstoreaccount1 supported
  • emulator connection string shorthands are supported
    • UseDevelopmentStorage=true
    • (with proxyURI) UseDevelopmentStorage=true;DevelopmentStorageProxyUri=proxyURI
• [Breaking] IE11 needs Object.assign polyfill loaded. PR #5727