@azure/storage-queue 12.26.0 → 12.27.0-beta.1

package/dist/browser/QueueServiceClient.d.ts

@@ -0,0 +1,411 @@
+import type { TokenCredential } from "@azure/core-auth";
+import type { QueueCreateResponse, QueueDeleteResponse, QueueItem, QueueServiceProperties, ServiceGetPropertiesResponse, ServiceGetStatisticsResponse, ServiceListQueuesSegmentResponse, ServiceSetPropertiesResponse } from "./generatedModels.js";
+import type { AbortSignalLike } from "@azure/abort-controller";
+import type { StoragePipelineOptions, Pipeline } from "./Pipeline.js";
+import type { CommonOptions } from "./StorageClient.js";
+import { StorageClient } from "./StorageClient.js";
+import type { PagedAsyncIterableIterator } from "@azure/core-paging";
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { AnonymousCredential } from "@azure/storage-blob";
+import type { QueueCreateOptions, QueueDeleteOptions } from "./QueueClient.js";
+import { QueueClient } from "./QueueClient.js";
+import { AccountSASPermissions } from "./AccountSASPermissions.js";
+import type { SASProtocol } from "./SASQueryParameters.js";
+import type { SasIPRange } from "./SasIPRange.js";
+/**
+ * Options to configure {@link QueueServiceClient.getProperties} operation
+ */
+export interface ServiceGetPropertiesOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+/**
+ * Options to configure {@link QueueServiceClient.setProperties} operation
+ */
+export interface ServiceSetPropertiesOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+/**
+ * Options to configure {@link QueueServiceClient.getStatistics} operation
+ */
+export interface ServiceGetStatisticsOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+}
+/**
+ * Options to configure {@link QueueServiceClient.listQueues} operation
+ */
+export interface ServiceListQueuesOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the @azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
+    /**
+     * Filters the results to return only queues
+     * whose name begins with the specified prefix.
+     */
+    prefix?: string;
+    /**
+     * Specifies whether the queue's metadata be returned as part of the response
+     * body.
+     */
+    includeMetadata?: boolean;
+}
+/**
+ * Options to configure {@link QueueServiceClient.generateAccountSasUrl} operation.
+ */
+export interface ServiceGenerateAccountSasUrlOptions {
+    /**
+     * The version of the service this SAS will target. If not specified, it will default to the version targeted by the
+     * library.
+     */
+    version?: string;
+    /**
+     * Optional. SAS protocols allowed.
+     */
+    protocol?: SASProtocol;
+    /**
+     * Optional. When the SAS will take effect.
+     */
+    startsOn?: Date;
+    /**
+     * Optional. IP range allowed.
+     */
+    ipRange?: SasIPRange;
+}
+/**
+ * A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you
+ * to manipulate queues.
+ */
+export declare class QueueServiceClient extends StorageClient {
+    /**
+     * Creates an instance of QueueServiceClient.
+     *
+     * @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
+     *                                  [ Note - Account connection string can only be used in NODE.JS runtime. ]
+     *                                  Account connection string example -
+     *                                  `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
+     *                                  SAS connection string example -
+     *                                  `BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
+     * @param options - Options to configure the HTTP pipeline.
+     * @returns A new QueueServiceClient object from the given connection string.
+     */
+    static fromConnectionString(connectionString: string, options?: StoragePipelineOptions): QueueServiceClient;
+    /**
+     * serviceContext provided by protocol layer.
+     */
+    private serviceContext;
+    /**
+     * Creates an instance of QueueServiceClient.
+     *
+     * @param url - A URL string pointing to Azure Storage queue service, such as
+     *                     "https://myaccount.queue.core.windows.net". You can append a SAS
+     *                     if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net?sasString".
+     * @param credential -  Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+     * @param options - Options to configure the HTTP pipeline.
+     *
+     * Example using DefaultAzureCredential from `@azure/identity`:
+     *
+     * ```ts snippet:ReadmeSampleCreateClient_DefaultAzureCredential
+     * import { DefaultAzureCredential } from "@azure/identity";
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     *
+     * const account = "<account>";
+     * const credential = new DefaultAzureCredential();
+     *
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   credential,
+     * );
+     * ```
+     *
+     * Example using an account name/key:
+     *
+     * ```ts snippet:ReadmeSampleCreateClient_StorageSharedKeyCredential
+     * import { StorageSharedKeyCredential, QueueServiceClient } from "@azure/storage-queue";
+     *
+     * // Enter your storage account name and shared key
+     * const account = "<account>";
+     * const accountKey = "<accountkey>";
+     *
+     * // Use StorageSharedKeyCredential with storage account and account key
+     * // StorageSharedKeyCredential is only available in Node.js runtime, not in browsers
+     * const sharedKeyCredential = new StorageSharedKeyCredential(account, accountKey);
+     *
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   sharedKeyCredential,
+     *   {
+     *     retryOptions: { maxTries: 4 }, // Retry options
+     *     userAgentOptions: {
+     *       userAgentPrefix: "BasicSample V10.0.0",
+     *     }, // Customized telemetry string
+     *   },
+     * );
+     * ```
+     */
+    constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions);
+    /**
+     * Creates an instance of QueueServiceClient.
+     *
+     * @param url - A URL string pointing to Azure Storage queue service, such as
+     *                     "https://myaccount.queue.core.windows.net". You can append a SAS
+     *                     if using AnonymousCredential, such as "https://myaccount.queue.core.windows.net?sasString".
+     * @param pipeline - Call newPipeline() to create a default
+     *                            pipeline, or provide a customized pipeline.
+     */
+    constructor(url: string, pipeline: Pipeline);
+    /**
+     * Creates a {@link QueueClient} object.
+     *
+     * @param queueName -
+     * @returns a new QueueClient
+     *
+     * Example usage:
+     *
+     * ```ts snippet:ReadmeSampleCreateQueue
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const queueName = "<valid queue name>";
+     * const queueClient = queueServiceClient.getQueueClient(queueName);
+     * const createQueueResponse = await queueClient.create();
+     * console.log(
+     *   `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
+     * );
+     * ```
+     */
+    getQueueClient(queueName: string): QueueClient;
+    /**
+     * Returns a list of the queues under the specified account.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/list-queues1
+     *
+     * @param marker - A string value that identifies the portion of
+     *                        the list of queues to be returned with the next listing operation. The
+     *                        operation returns the continuationToken value within the response body if the
+     *                        listing operation did not return all queues remaining to be listed
+     *                        with the current page. The continuationToken value can be used as the value for
+     *                        the marker parameter in a subsequent call to request the next page of list
+     *                        items. The marker value is opaque to the client.
+     * @param options - Options to list queues operation.
+     * @returns Response data for the list queues segment operation.
+     */
+    private listQueuesSegment;
+    /**
+     * Returns an AsyncIterableIterator for {@link ServiceListQueuesSegmentResponse} objects
+     *
+     * @param marker - A string value that identifies the portion of
+     *                        the list of queues to be returned with the next listing operation. The
+     *                        operation returns the continuationToken value within the response body if the
+     *                        listing operation did not return all queues remaining to be listed
+     *                        with the current page. The continuationToken value can be used as the value for
+     *                        the marker parameter in a subsequent call to request the next page of list
+     *                        items. The marker value is opaque to the client.
+     * @param options - Options to list queues operation.
+     */
+    private listSegments;
+    /**
+     * Returns an AsyncIterableIterator for {@link QueueItem} objects
+     *
+     * @param options - Options to list queues operation.
+     */
+    private listItems;
+    /**
+     * Returns an async iterable iterator to list all the queues
+     * under the specified account.
+     *
+     * .byPage() returns an async iterable iterator to list the queues in pages.
+     *
+     * Example using `for await` syntax:
+     *
+     * ```ts snippet:ReadmeSampleListQueues
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * let i = 1;
+     * for await (const item of queueServiceClient.listQueues()) {
+     *   console.log(`Queue${i++}: ${item.name}`);
+     * }
+     * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```ts snippet:ReadmeSampleListQueues_Iterator
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * let i = 1;
+     * const iterator = queueServiceClient.listQueues();
+     * let { done, value } = await iterator.next();
+     * while (!done) {
+     *   console.log(`Queue${i++}: ${value.name}`);
+     *   ({ done, value } = await iterator.next());
+     * }
+     * ```
+     *
+     * Example using `byPage()`:
+     *
+     * ```ts snippet:ReadmeSampleListQueues_ByPage
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * let i = 1;
+     * for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
+     *   for (const item of page.queueItems || []) {
+     *     console.log(`Queue${i++}: ${item.name}`);
+     *   }
+     * }
+     * ```
+     *
+     * Example using paging with a marker:
+     *
+     * ```ts snippet:ReadmeSampleListQueues_Continuation
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * let i = 1;
+     * let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
+     * let response = (await iterator.next()).value;
+     * // Prints 2 queues
+     * if (response.queueItems) {
+     *   for (const item of response.queueItems) {
+     *     console.log(`Queue${i++}: ${item.name}`);
+     *   }
+     * }
+     * // Gets next marker
+     * let marker = response.continuationToken;
+     * // Passing next marker as continuationToken
+     * iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
+     * response = (await iterator.next()).value;
+     * // Prints 10 queues
+     * if (response.queueItems) {
+     *   for (const item of response.queueItems) {
+     *     console.log(`Queue${i++}: ${item.name}`);
+     *   }
+     * }
+     * ```
+     *
+     * @param options - Options to list queues operation.
+     * @returns An asyncIterableIterator that supports paging.
+     */
+    listQueues(options?: ServiceListQueuesOptions): PagedAsyncIterableIterator<QueueItem, ServiceListQueuesSegmentResponse>;
+    /**
+     * Gets the properties of a storage account’s Queue service, including properties
+     * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-properties
+     *
+     * @param options - Options to get properties operation.
+     * @returns Response data including the queue service properties.
+     */
+    getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>;
+    /**
+     * Sets properties for a storage account’s Queue service endpoint, including properties
+     * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/set-queue-service-properties
+     *
+     * @param properties -
+     * @param options - Options to set properties operation.
+     * @returns Response data for the Set Properties operation.
+     */
+    setProperties(properties: QueueServiceProperties, options?: ServiceGetPropertiesOptions): Promise<ServiceSetPropertiesResponse>;
+    /**
+     * Retrieves statistics related to replication for the Queue service. It is only
+     * available on the secondary location endpoint when read-access geo-redundant
+     * replication is enabled for the storage account.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/get-queue-service-stats
+     *
+     * @param options - Options to get statistics operation.
+     * @returns Response data for get statistics the operation.
+     */
+    getStatistics(options?: ServiceGetStatisticsOptions): Promise<ServiceGetStatisticsResponse>;
+    /**
+     * Creates a new queue under the specified account.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-queue4
+     *
+     * @param queueName - name of the queue to create
+     * @param options - Options to Queue create operation.
+     * @returns Response data for the Queue create operation.
+     */
+    createQueue(queueName: string, options?: QueueCreateOptions): Promise<QueueCreateResponse>;
+    /**
+     * Deletes the specified queue permanently.
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/delete-queue3
+     *
+     * @param queueName - name of the queue to delete.
+     * @param options - Options to Queue delete operation.
+     * @returns Response data for the Queue delete operation.
+     */
+    deleteQueue(queueName: string, options?: QueueDeleteOptions): Promise<QueueDeleteResponse>;
+    /**
+     * Only available for QueueServiceClient constructed with a shared key credential.
+     *
+     * Generates an account Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the shared key credential of the client.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     *
+     * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
+     * @param permissions - Specifies the list of permissions to be associated with the SAS.
+     * @param resourceTypes - Specifies the resource types associated with the shared access signature.
+     * @param options - Optional parameters.
+     * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string;
+    /**
+     * Only available for QueueServiceClient constructed with a shared key credential.
+     *
+     * Generates string to sign for an account Shared Access Signature (SAS) URI based on the client properties
+     * and parameters passed in. The SAS is signed by the shared key credential of the client.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/create-account-sas
+     *
+     * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not specified.
+     * @param permissions - Specifies the list of permissions to be associated with the SAS.
+     * @param resourceTypes - Specifies the resource types associated with the shared access signature.
+     * @param options - Optional parameters.
+     * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+     */
+    generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string;
+}
+//# sourceMappingURL=QueueServiceClient.d.ts.map

package/dist/browser/QueueServiceClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"QueueServiceClient.d.ts","sourceRoot":"","sources":["../../src/QueueServiceClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAGxD,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,EACT,sBAAsB,EACtB,4BAA4B,EAE5B,4BAA4B,EAC5B,gCAAgC,EAChC,4BAA4B,EAM7B,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE/D,OAAO,KAAK,EAAE,sBAAsB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEtE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,KAAK,EAAgB,0BAA0B,EAAE,MAAM,oBAAoB,CAAC;AAOnF,OAAO,EAAE,0BAA0B,EAAE,MAAM,qBAAqB,CAAC;AACjE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AAMnE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAGlD;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,aAAa;IAChE;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;CAC/B;AAuCD;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,aAAa;IAC7D;;;OAGG;IACH,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,mCAAmC;IAClD;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,kBAAmB,SAAQ,aAAa;IACnD;;;;;;;;;;;OAWG;WACW,oBAAoB,CAChC,gBAAgB,EAAE,MAAM,EAGxB,OAAO,CAAC,EAAE,sBAAsB,GAC/B,kBAAkB;IA2BrB;;OAEG;IACH,OAAO,CAAC,cAAc,CAAU;IAEhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;gBAED,GAAG,EAAE,MAAM,EACX,UAAU,CAAC,EAAE,0BAA0B,GAAG,mBAAmB,GAAG,eAAe,EAG/E,OAAO,CAAC,EAAE,sBAAsB;IAElC;;;;;;;;OAQG;gBACS,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ;IA6B3C;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACI,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,WAAW;IAIrD;;;;;;;;;;;;;OAaG;YACW,iBAAiB;IA2B/B;;;;;;;;;;;OAWG;YACY,YAAY;IAgB3B;;;;OAIG;YACY,SAAS;IAexB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqGG;IACI,UAAU,CACf,OAAO,GAAE,wBAA6B,GACrC,0BAA0B,CAAC,SAAS,EAAE,gCAAgC,CAAC;IAqC1E;;;;;;;OAOG;IACU,aAAa,CACxB,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,CAAC;IAcxC;;;;;;;;OAQG;IACU,aAAa,CACxB,UAAU,EAAE,sBAAsB,EAClC,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,CAAC;IAYxC;;;;;;;;OAQG;IACU,aAAa,CACxB,OAAO,GAAE,2BAAgC,GACxC,OAAO,CAAC,4BAA4B,CAAC;IAcxC;;;;;;;OAOG;IACU,WAAW,CACtB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,mBAAmB,CAAC;IAU/B;;;;;;;OAOG;IACU,WAAW,CACtB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,kBAAuB,GAC/B,OAAO,CAAC,mBAAmB,CAAC;IAU/B;;;;;;;;;;;;;OAaG;IACI,qBAAqB,CAC1B,SAAS,CAAC,EAAE,IAAI,EAChB,WAAW,GAAE,qBAAwD,EACrE,aAAa,GAAE,MAAc,EAC7B,OAAO,GAAE,mCAAwC,GAChD,MAAM;IA0BT;;;;;;;;;;;;;OAaG;IACI,uBAAuB,CAC5B,SAAS,CAAC,EAAE,IAAI,EAChB,WAAW,GAAE,qBAAwD,EACrE,aAAa,GAAE,MAAc,EAC7B,OAAO,GAAE,mCAAwC,GAChD,MAAM;CAuBV"}

package/{dist-esm/storage-queue/src → dist/browser}/QueueServiceClient.js

@@ -2,17 +2,17 @@
 // Licensed under the MIT License.
 import { __asyncDelegator, __asyncGenerator, __asyncValues, __await } from "tslib";
 import { isTokenCredential } from "@azure/core-auth";
-import { isNode } from "@azure/core-util";
-import { newPipeline, isPipelineLike } from "./Pipeline";
-import { StorageClient } from "./StorageClient";
-import { appendToURLPath, appendToURLQuery, extractConnectionStringParts, assertResponse, } from "./utils/utils.common";
-import { StorageSharedKeyCredential } from "../../storage-blob/src/credentials/StorageSharedKeyCredential";
-import { AnonymousCredential } from "../../storage-blob/src/credentials/AnonymousCredential";
-import { tracingClient } from "./utils/tracing";
-import { QueueClient } from "./QueueClient";
-import { AccountSASPermissions } from "./AccountSASPermissions";
-import { generateAccountSASQueryParameters, generateAccountSASQueryParametersInternal, } from "./AccountSASSignatureValues";
-import { AccountSASServices } from "./AccountSASServices";
+import { isNodeLike } from "@azure/core-util";
+import { newPipeline, isPipelineLike } from "./Pipeline.js";
+import { StorageClient } from "./StorageClient.js";
+import { appendToURLPath, appendToURLQuery, extractConnectionStringParts, assertResponse, } from "./utils/utils.common.js";
+import { StorageSharedKeyCredential } from "@azure/storage-blob";
+import { AnonymousCredential } from "@azure/storage-blob";
+import { tracingClient } from "./utils/tracing.js";
+import { QueueClient } from "./QueueClient.js";
+import { AccountSASPermissions } from "./AccountSASPermissions.js";
+import { generateAccountSASQueryParameters, generateAccountSASQueryParametersInternal, } from "./AccountSASSignatureValues.js";
+import { AccountSASServices } from "./AccountSASServices.js";
 import { getDefaultProxySettings } from "@azure/core-rest-pipeline";
 /**
  * A QueueServiceClient represents a URL to the Azure Storage Queue service allowing you
@@ -38,7 +38,7 @@ export class QueueServiceClient extends StorageClient {
         options = options || {};
         const extractedCreds = extractConnectionStringParts(connectionString);
         if (extractedCreds.kind === "AccountConnString") {
-            if (isNode) {
+            if (isNodeLike) {
                 const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
                 if (!options.proxyOptions) {
                     options.proxyOptions = getDefaultProxySettings(extractedCreds.proxyUri);
@@ -66,7 +66,7 @@ export class QueueServiceClient extends StorageClient {
         if (isPipelineLike(credentialOrPipeline)) {
             pipeline = credentialOrPipeline;
         }
-        else if ((isNode && credentialOrPipeline instanceof StorageSharedKeyCredential) ||
+        else if ((isNodeLike && credentialOrPipeline instanceof StorageSharedKeyCredential) ||
             credentialOrPipeline instanceof AnonymousCredential ||
             isTokenCredential(credentialOrPipeline)) {
             pipeline = newPipeline(credentialOrPipeline, options);
@@ -86,9 +86,22 @@ export class QueueServiceClient extends StorageClient {
      *
      * Example usage:
      *
-     * ```js
-     * const queueClient = queueServiceClient.getQueueClient("<new queue name>");
+     * ```ts snippet:ReadmeSampleCreateQueue
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
+     * const queueName = "<valid queue name>";
+     * const queueClient = queueServiceClient.getQueueClient(queueName);
      * const createQueueResponse = await queueClient.create();
+     * console.log(
+     *   `Created queue ${queueName} successfully, service assigned request Id: ${createQueueResponse.requestId}`,
+     * );
      * ```
      */
     getQueueClient(queueName) {
@@ -180,68 +193,93 @@ export class QueueServiceClient extends StorageClient {
      *
      * Example using `for await` syntax:
      *
-     * ```js
+     * ```ts snippet:ReadmeSampleListQueues
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
      * let i = 1;
      * for await (const item of queueServiceClient.listQueues()) {
-     *   console.log(`Queue${i}: ${item.name}`);
-     *   i++;
+     *   console.log(`Queue${i++}: ${item.name}`);
      * }
      * ```
      *
      * Example using `iter.next()`:
      *
-     * ```js
+     * ```ts snippet:ReadmeSampleListQueues_Iterator
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
      * let i = 1;
-     * let iterator = queueServiceClient.listQueues();
-     * let item = await iterator.next();
-     * while (!item.done) {
-     *   console.log(`Queue${i}: ${item.value.name}`);
-     *   i++;
-     *   item = await iterator.next();
+     * const iterator = queueServiceClient.listQueues();
+     * let { done, value } = await iterator.next();
+     * while (!done) {
+     *   console.log(`Queue${i++}: ${value.name}`);
+     *   ({ done, value } = await iterator.next());
      * }
      * ```
      *
      * Example using `byPage()`:
      *
-     * ```js
-     * // passing optional maxPageSize in the page settings
+     * ```ts snippet:ReadmeSampleListQueues_ByPage
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
      * let i = 1;
-     * for await (const item2 of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
-     *   if (item2.queueItems) {
-     *     for (const queueItem of item2.queueItems) {
-     *       console.log(`Queue${i}: ${queueItem.name}`);
-     *       i++;
-     *     }
+     * for await (const page of queueServiceClient.listQueues().byPage({ maxPageSize: 20 })) {
+     *   for (const item of page.queueItems || []) {
+     *     console.log(`Queue${i++}: ${item.name}`);
      *   }
      * }
      * ```
      *
      * Example using paging with a marker:
      *
-     * ```js
+     * ```ts snippet:ReadmeSampleListQueues_Continuation
+     * import { QueueServiceClient } from "@azure/storage-queue";
+     * import { DefaultAzureCredential } from "@azure/identity";
+     *
+     * const account = "<account>";
+     * const queueServiceClient = new QueueServiceClient(
+     *   `https://${account}.queue.core.windows.net`,
+     *   new DefaultAzureCredential(),
+     * );
+     *
      * let i = 1;
      * let iterator = queueServiceClient.listQueues().byPage({ maxPageSize: 2 });
-     * let item = (await iterator.next()).value;
-     *
-     * // Prints 2 queue names
-     * if (item.queueItems) {
-     *   for (const queueItem of item.queueItems) {
-     *     console.log(`Queue${i}: ${queueItem.name}`);
-     *     i++;
+     * let response = (await iterator.next()).value;
+     * // Prints 2 queues
+     * if (response.queueItems) {
+     *   for (const item of response.queueItems) {
+     *     console.log(`Queue${i++}: ${item.name}`);
      *   }
      * }
      * // Gets next marker
-     * let marker = item.continuationToken;
-     *
+     * let marker = response.continuationToken;
      * // Passing next marker as continuationToken
      * iterator = queueServiceClient.listQueues().byPage({ continuationToken: marker, maxPageSize: 10 });
-     * item = (await iterator.next()).value;
-     *
-     * // Prints 10 queue names
-     * if (item.queueItems) {
-     *   for (const queueItem of item.queueItems) {
-     *     console.log(`Queue${i}: ${queueItem.name}`);
-     *     i++;
+     * response = (await iterator.next()).value;
+     * // Prints 10 queues
+     * if (response.queueItems) {
+     *   for (const item of response.queueItems) {
+     *     console.log(`Queue${i++}: ${item.name}`);
      *   }
      * }
      * ```