@azure/storage-blob 12.31.0 → 12.32.0-beta.1

package/dist/commonjs/BlobQueryResponse.js

@@ -1,373 +1,389 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT License.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BlobQueryResponse = void 0;
-const core_util_1 = require("@azure/core-util");
-const BlobQuickQueryStream_js_1 = require("./utils/BlobQuickQueryStream.js");
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * BlobQueryResponse implements BlobDownloadResponseModel interface, and in Node.js runtime it will
- * parse avro data returned by blob query.
- */
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var BlobQueryResponse_exports = {};
+__export(BlobQueryResponse_exports, {
+  BlobQueryResponse: () => BlobQueryResponse
+});
+module.exports = __toCommonJS(BlobQueryResponse_exports);
+var import_core_util = require("@azure/core-util");
+var import_BlobQuickQueryStream = require("./utils/BlobQuickQueryStream.js");
 class BlobQueryResponse {
-    /**
-     * Indicates that the service supports
-     * requests for partial file content.
-     *
-     * @readonly
-     */
-    get acceptRanges() {
-        return this.originalResponse.acceptRanges;
-    }
-    /**
-     * Returns if it was previously specified
-     * for the file.
-     *
-     * @readonly
-     */
-    get cacheControl() {
-        return this.originalResponse.cacheControl;
-    }
-    /**
-     * Returns the value that was specified
-     * for the 'x-ms-content-disposition' header and specifies how to process the
-     * response.
-     *
-     * @readonly
-     */
-    get contentDisposition() {
-        return this.originalResponse.contentDisposition;
-    }
-    /**
-     * Returns the value that was specified
-     * for the Content-Encoding request header.
-     *
-     * @readonly
-     */
-    get contentEncoding() {
-        return this.originalResponse.contentEncoding;
-    }
-    /**
-     * Returns the value that was specified
-     * for the Content-Language request header.
-     *
-     * @readonly
-     */
-    get contentLanguage() {
-        return this.originalResponse.contentLanguage;
-    }
-    /**
-     * The current sequence number for a
-     * page blob. This header is not returned for block blobs or append blobs.
-     *
-     * @readonly
-     */
-    get blobSequenceNumber() {
-        return this.originalResponse.blobSequenceNumber;
-    }
-    /**
-     * The blob's type. Possible values include:
-     * 'BlockBlob', 'PageBlob', 'AppendBlob'.
-     *
-     * @readonly
-     */
-    get blobType() {
-        return this.originalResponse.blobType;
-    }
-    /**
-     * The number of bytes present in the
-     * response body.
-     *
-     * @readonly
-     */
-    get contentLength() {
-        return this.originalResponse.contentLength;
-    }
-    /**
-     * If the file has an MD5 hash and the
-     * request is to read the full file, this response header is returned so that
-     * the client can check for message content integrity. If the request is to
-     * read a specified range and the 'x-ms-range-get-content-md5' is set to
-     * true, then the request returns an MD5 hash for the range, as long as the
-     * range size is less than or equal to 4 MB. If neither of these sets of
-     * conditions is true, then no value is returned for the 'Content-MD5'
-     * header.
-     *
-     * @readonly
-     */
-    get contentMD5() {
-        return this.originalResponse.contentMD5;
-    }
-    /**
-     * Indicates the range of bytes returned if
-     * the client requested a subset of the file by setting the Range request
-     * header.
-     *
-     * @readonly
-     */
-    get contentRange() {
-        return this.originalResponse.contentRange;
-    }
-    /**
-     * The content type specified for the file.
-     * The default content type is 'application/octet-stream'
-     *
-     * @readonly
-     */
-    get contentType() {
-        return this.originalResponse.contentType;
-    }
-    /**
-     * Conclusion time of the last attempted
-     * Copy File operation where this file was the destination file. This value
-     * can specify the time of a completed, aborted, or failed copy attempt.
-     *
-     * @readonly
-     */
-    get copyCompletedOn() {
-        return undefined;
-    }
-    /**
-     * String identifier for the last attempted Copy
-     * File operation where this file was the destination file.
-     *
-     * @readonly
-     */
-    get copyId() {
-        return this.originalResponse.copyId;
-    }
-    /**
-     * Contains the number of bytes copied and
-     * the total bytes in the source in the last attempted Copy File operation
-     * where this file was the destination file. Can show between 0 and
-     * Content-Length bytes copied.
-     *
-     * @readonly
-     */
-    get copyProgress() {
-        return this.originalResponse.copyProgress;
-    }
-    /**
-     * URL up to 2KB in length that specifies the
-     * source file used in the last attempted Copy File operation where this file
-     * was the destination file.
-     *
-     * @readonly
-     */
-    get copySource() {
-        return this.originalResponse.copySource;
-    }
-    /**
-     * State of the copy operation
-     * identified by 'x-ms-copy-id'. Possible values include: 'pending',
-     * 'success', 'aborted', 'failed'
-     *
-     * @readonly
-     */
-    get copyStatus() {
-        return this.originalResponse.copyStatus;
-    }
-    /**
-     * Only appears when
-     * x-ms-copy-status is failed or pending. Describes cause of fatal or
-     * non-fatal copy operation failure.
-     *
-     * @readonly
-     */
-    get copyStatusDescription() {
-        return this.originalResponse.copyStatusDescription;
-    }
-    /**
-     * When a blob is leased,
-     * specifies whether the lease is of infinite or fixed duration. Possible
-     * values include: 'infinite', 'fixed'.
-     *
-     * @readonly
-     */
-    get leaseDuration() {
-        return this.originalResponse.leaseDuration;
-    }
-    /**
-     * Lease state of the blob. Possible
-     * values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
-     *
-     * @readonly
-     */
-    get leaseState() {
-        return this.originalResponse.leaseState;
-    }
-    /**
-     * The current lease status of the
-     * blob. Possible values include: 'locked', 'unlocked'.
-     *
-     * @readonly
-     */
-    get leaseStatus() {
-        return this.originalResponse.leaseStatus;
-    }
-    /**
-     * A UTC date/time value generated by the service that
-     * indicates the time at which the response was initiated.
-     *
-     * @readonly
-     */
-    get date() {
-        return this.originalResponse.date;
-    }
-    /**
-     * The number of committed blocks
-     * present in the blob. This header is returned only for append blobs.
-     *
-     * @readonly
-     */
-    get blobCommittedBlockCount() {
-        return this.originalResponse.blobCommittedBlockCount;
-    }
-    /**
-     * The ETag contains a value that you can use to
-     * perform operations conditionally, in quotes.
-     *
-     * @readonly
-     */
-    get etag() {
-        return this.originalResponse.etag;
-    }
-    /**
-     * The error code.
-     *
-     * @readonly
-     */
-    get errorCode() {
-        return this.originalResponse.errorCode;
-    }
-    /**
-     * The value of this header is set to
-     * true if the file data and application metadata are completely encrypted
-     * using the specified algorithm. Otherwise, the value is set to false (when
-     * the file is unencrypted, or if only parts of the file/application metadata
-     * are encrypted).
-     *
-     * @readonly
-     */
-    get isServerEncrypted() {
-        return this.originalResponse.isServerEncrypted;
-    }
-    /**
-     * If the blob has a MD5 hash, and if
-     * request contains range header (Range or x-ms-range), this response header
-     * is returned with the value of the whole blob's MD5 value. This value may
-     * or may not be equal to the value returned in Content-MD5 header, with the
-     * latter calculated from the requested range.
-     *
-     * @readonly
-     */
-    get blobContentMD5() {
-        return this.originalResponse.blobContentMD5;
-    }
-    /**
-     * Returns the date and time the file was last
-     * modified. Any operation that modifies the file or its properties updates
-     * the last modified time.
-     *
-     * @readonly
-     */
-    get lastModified() {
-        return this.originalResponse.lastModified;
-    }
-    /**
-     * A name-value pair
-     * to associate with a file storage object.
-     *
-     * @readonly
-     */
-    get metadata() {
-        return this.originalResponse.metadata;
-    }
-    /**
-     * This header uniquely identifies the request
-     * that was made and can be used for troubleshooting the request.
-     *
-     * @readonly
-     */
-    get requestId() {
-        return this.originalResponse.requestId;
-    }
-    /**
-     * If a client request id header is sent in the request, this header will be present in the
-     * response with the same value.
-     *
-     * @readonly
-     */
-    get clientRequestId() {
-        return this.originalResponse.clientRequestId;
-    }
-    /**
-     * Indicates the version of the File service used
-     * to execute the request.
-     *
-     * @readonly
-     */
-    get version() {
-        return this.originalResponse.version;
-    }
-    /**
-     * The SHA-256 hash of the encryption key used to encrypt the blob. This value is only returned
-     * when the blob was encrypted with a customer-provided key.
-     *
-     * @readonly
-     */
-    get encryptionKeySha256() {
-        return this.originalResponse.encryptionKeySha256;
-    }
-    /**
-     * If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to
-     * true, then the request returns a crc64 for the range, as long as the range size is less than
-     * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is
-     * specified in the same request, it will fail with 400(Bad Request)
-     */
-    get contentCrc64() {
-        return this.originalResponse.contentCrc64;
-    }
-    /**
-     * The response body as a browser Blob.
-     * Always undefined in node.js.
-     *
-     * @readonly
-     */
-    get blobBody() {
-        return undefined;
-    }
-    /**
-     * The response body as a node.js Readable stream.
-     * Always undefined in the browser.
-     *
-     * It will parse avor data returned by blob query.
-     *
-     * @readonly
-     */
-    get readableStreamBody() {
-        return core_util_1.isNodeLike ? this.blobDownloadStream : undefined;
-    }
-    /**
-     * The HTTP response.
-     */
-    get _response() {
-        return this.originalResponse._response;
-    }
-    originalResponse;
-    blobDownloadStream;
-    /**
-     * Creates an instance of BlobQueryResponse.
-     *
-     * @param originalResponse -
-     * @param options -
-     */
-    constructor(originalResponse, options = {}) {
-        this.originalResponse = originalResponse;
-        this.blobDownloadStream = new BlobQuickQueryStream_js_1.BlobQuickQueryStream(this.originalResponse.readableStreamBody, options);
-    }
+  /**
+   * Indicates that the service supports
+   * requests for partial file content.
+   *
+   * @readonly
+   */
+  get acceptRanges() {
+    return this.originalResponse.acceptRanges;
+  }
+  /**
+   * Returns if it was previously specified
+   * for the file.
+   *
+   * @readonly
+   */
+  get cacheControl() {
+    return this.originalResponse.cacheControl;
+  }
+  /**
+   * Returns the value that was specified
+   * for the 'x-ms-content-disposition' header and specifies how to process the
+   * response.
+   *
+   * @readonly
+   */
+  get contentDisposition() {
+    return this.originalResponse.contentDisposition;
+  }
+  /**
+   * Returns the value that was specified
+   * for the Content-Encoding request header.
+   *
+   * @readonly
+   */
+  get contentEncoding() {
+    return this.originalResponse.contentEncoding;
+  }
+  /**
+   * Returns the value that was specified
+   * for the Content-Language request header.
+   *
+   * @readonly
+   */
+  get contentLanguage() {
+    return this.originalResponse.contentLanguage;
+  }
+  /**
+   * The current sequence number for a
+   * page blob. This header is not returned for block blobs or append blobs.
+   *
+   * @readonly
+   */
+  get blobSequenceNumber() {
+    return this.originalResponse.blobSequenceNumber;
+  }
+  /**
+   * The blob's type. Possible values include:
+   * 'BlockBlob', 'PageBlob', 'AppendBlob'.
+   *
+   * @readonly
+   */
+  get blobType() {
+    return this.originalResponse.blobType;
+  }
+  /**
+   * The number of bytes present in the
+   * response body.
+   *
+   * @readonly
+   */
+  get contentLength() {
+    return this.originalResponse.contentLength;
+  }
+  /**
+   * If the file has an MD5 hash and the
+   * request is to read the full file, this response header is returned so that
+   * the client can check for message content integrity. If the request is to
+   * read a specified range and the 'x-ms-range-get-content-md5' is set to
+   * true, then the request returns an MD5 hash for the range, as long as the
+   * range size is less than or equal to 4 MB. If neither of these sets of
+   * conditions is true, then no value is returned for the 'Content-MD5'
+   * header.
+   *
+   * @readonly
+   */
+  get contentMD5() {
+    return this.originalResponse.contentMD5;
+  }
+  /**
+   * Indicates the range of bytes returned if
+   * the client requested a subset of the file by setting the Range request
+   * header.
+   *
+   * @readonly
+   */
+  get contentRange() {
+    return this.originalResponse.contentRange;
+  }
+  /**
+   * The content type specified for the file.
+   * The default content type is 'application/octet-stream'
+   *
+   * @readonly
+   */
+  get contentType() {
+    return this.originalResponse.contentType;
+  }
+  /**
+   * Conclusion time of the last attempted
+   * Copy File operation where this file was the destination file. This value
+   * can specify the time of a completed, aborted, or failed copy attempt.
+   *
+   * @readonly
+   */
+  get copyCompletedOn() {
+    return void 0;
+  }
+  /**
+   * String identifier for the last attempted Copy
+   * File operation where this file was the destination file.
+   *
+   * @readonly
+   */
+  get copyId() {
+    return this.originalResponse.copyId;
+  }
+  /**
+   * Contains the number of bytes copied and
+   * the total bytes in the source in the last attempted Copy File operation
+   * where this file was the destination file. Can show between 0 and
+   * Content-Length bytes copied.
+   *
+   * @readonly
+   */
+  get copyProgress() {
+    return this.originalResponse.copyProgress;
+  }
+  /**
+   * URL up to 2KB in length that specifies the
+   * source file used in the last attempted Copy File operation where this file
+   * was the destination file.
+   *
+   * @readonly
+   */
+  get copySource() {
+    return this.originalResponse.copySource;
+  }
+  /**
+   * State of the copy operation
+   * identified by 'x-ms-copy-id'. Possible values include: 'pending',
+   * 'success', 'aborted', 'failed'
+   *
+   * @readonly
+   */
+  get copyStatus() {
+    return this.originalResponse.copyStatus;
+  }
+  /**
+   * Only appears when
+   * x-ms-copy-status is failed or pending. Describes cause of fatal or
+   * non-fatal copy operation failure.
+   *
+   * @readonly
+   */
+  get copyStatusDescription() {
+    return this.originalResponse.copyStatusDescription;
+  }
+  /**
+   * When a blob is leased,
+   * specifies whether the lease is of infinite or fixed duration. Possible
+   * values include: 'infinite', 'fixed'.
+   *
+   * @readonly
+   */
+  get leaseDuration() {
+    return this.originalResponse.leaseDuration;
+  }
+  /**
+   * Lease state of the blob. Possible
+   * values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
+   *
+   * @readonly
+   */
+  get leaseState() {
+    return this.originalResponse.leaseState;
+  }
+  /**
+   * The current lease status of the
+   * blob. Possible values include: 'locked', 'unlocked'.
+   *
+   * @readonly
+   */
+  get leaseStatus() {
+    return this.originalResponse.leaseStatus;
+  }
+  /**
+   * A UTC date/time value generated by the service that
+   * indicates the time at which the response was initiated.
+   *
+   * @readonly
+   */
+  get date() {
+    return this.originalResponse.date;
+  }
+  /**
+   * The number of committed blocks
+   * present in the blob. This header is returned only for append blobs.
+   *
+   * @readonly
+   */
+  get blobCommittedBlockCount() {
+    return this.originalResponse.blobCommittedBlockCount;
+  }
+  /**
+   * The ETag contains a value that you can use to
+   * perform operations conditionally, in quotes.
+   *
+   * @readonly
+   */
+  get etag() {
+    return this.originalResponse.etag;
+  }
+  /**
+   * The error code.
+   *
+   * @readonly
+   */
+  get errorCode() {
+    return this.originalResponse.errorCode;
+  }
+  /**
+   * The value of this header is set to
+   * true if the file data and application metadata are completely encrypted
+   * using the specified algorithm. Otherwise, the value is set to false (when
+   * the file is unencrypted, or if only parts of the file/application metadata
+   * are encrypted).
+   *
+   * @readonly
+   */
+  get isServerEncrypted() {
+    return this.originalResponse.isServerEncrypted;
+  }
+  /**
+   * If the blob has a MD5 hash, and if
+   * request contains range header (Range or x-ms-range), this response header
+   * is returned with the value of the whole blob's MD5 value. This value may
+   * or may not be equal to the value returned in Content-MD5 header, with the
+   * latter calculated from the requested range.
+   *
+   * @readonly
+   */
+  get blobContentMD5() {
+    return this.originalResponse.blobContentMD5;
+  }
+  /**
+   * Returns the date and time the file was last
+   * modified. Any operation that modifies the file or its properties updates
+   * the last modified time.
+   *
+   * @readonly
+   */
+  get lastModified() {
+    return this.originalResponse.lastModified;
+  }
+  /**
+   * A name-value pair
+   * to associate with a file storage object.
+   *
+   * @readonly
+   */
+  get metadata() {
+    return this.originalResponse.metadata;
+  }
+  /**
+   * This header uniquely identifies the request
+   * that was made and can be used for troubleshooting the request.
+   *
+   * @readonly
+   */
+  get requestId() {
+    return this.originalResponse.requestId;
+  }
+  /**
+   * If a client request id header is sent in the request, this header will be present in the
+   * response with the same value.
+   *
+   * @readonly
+   */
+  get clientRequestId() {
+    return this.originalResponse.clientRequestId;
+  }
+  /**
+   * Indicates the version of the File service used
+   * to execute the request.
+   *
+   * @readonly
+   */
+  get version() {
+    return this.originalResponse.version;
+  }
+  /**
+   * The SHA-256 hash of the encryption key used to encrypt the blob. This value is only returned
+   * when the blob was encrypted with a customer-provided key.
+   *
+   * @readonly
+   */
+  get encryptionKeySha256() {
+    return this.originalResponse.encryptionKeySha256;
+  }
+  /**
+   * If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to
+   * true, then the request returns a crc64 for the range, as long as the range size is less than
+   * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is
+   * specified in the same request, it will fail with 400(Bad Request)
+   */
+  get contentCrc64() {
+    return this.originalResponse.contentCrc64;
+  }
+  /**
+   * The response body as a browser Blob.
+   * Always undefined in node.js.
+   *
+   * @readonly
+   */
+  get blobBody() {
+    return void 0;
+  }
+  /**
+   * The response body as a node.js Readable stream.
+   * Always undefined in the browser.
+   *
+   * It will parse avor data returned by blob query.
+   *
+   * @readonly
+   */
+  get readableStreamBody() {
+    return import_core_util.isNodeLike ? this.blobDownloadStream : void 0;
+  }
+  /**
+   * The HTTP response.
+   */
+  get _response() {
+    return this.originalResponse._response;
+  }
+  originalResponse;
+  blobDownloadStream;
+  /**
+   * Creates an instance of BlobQueryResponse.
+   *
+   * @param originalResponse -
+   * @param options -
+   */
+  constructor(originalResponse, options = {}) {
+    this.originalResponse = originalResponse;
+    this.blobDownloadStream = new import_BlobQuickQueryStream.BlobQuickQueryStream(
+      this.originalResponse.readableStreamBody,
+      options
+    );
+  }
 }
-exports.BlobQueryResponse = BlobQueryResponse;
-//# sourceMappingURL=BlobQueryResponse.js.map
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  BlobQueryResponse
+});