StorageBrowserPolicy.yml

### YamlMime:TSType
name: StorageBrowserPolicy
uid: '@azure/storage-queue.StorageBrowserPolicy'
package: '@azure/storage-queue'
summary: >-
  StorageBrowserPolicy will handle differences between Node.js and browser
  runtime, including:


  1. Browsers cache GET/HEAD requests by adding conditional headers such as
  'IF_MODIFIED_SINCE'.

  StorageBrowserPolicy is a policy used to add a timestamp query to GET/HEAD
  request URL

  thus avoid the browser cache.


  2. Remove cookie header for security


  3. Remove content-length header to avoid browsers warning
fullName: StorageBrowserPolicy
remarks: ''
isDeprecated: false
type: class
constructors:
  - name: StorageBrowserPolicy(RequestPolicy, RequestPolicyOptionsLike)
    uid: '@azure/storage-queue.StorageBrowserPolicy.constructor'
    package: '@azure/storage-queue'
    summary: Creates an instance of StorageBrowserPolicy.
    remarks: ''
    isDeprecated: false
    syntax:
      content: >-
        new StorageBrowserPolicy(nextPolicy: RequestPolicy, options:
        RequestPolicyOptionsLike)
      parameters:
        - id: nextPolicy
          type: <xref uid="@azure/storage-queue.IHttpClient" />
          description: ''
        - id: options
          type: <xref uid="@azure/storage-queue.RequestPolicyOptions" />
          description: ''
inheritedMethods:
  - name: log(HttpPipelineLogLevel, string)
    uid: '@azure/storage-queue.StorageBrowserPolicy.log'
    package: '@azure/storage-queue'
    summary: >-
      Attempt to log the provided message to the provided logger. If no logger
      was provided or if

      the log level does not meat the logger's threshold, then nothing will be
      logged.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function log(logLevel: HttpPipelineLogLevel, message: string)'
      parameters:
        - id: logLevel
          type: <xref uid="@azure/core-http-compat.HttpPipelineLogLevel" />
          description: The log level of this log.
        - id: message
          type: string
          description: The message of this log.
    inheritanceDescription: >-
      <b>Inherited From</b>
      [BaseRequestPolicy.log](xref:@azure/storage-queue.BaseRequestPolicy.log)
  - name: shouldLog(HttpPipelineLogLevel)
    uid: '@azure/storage-queue.StorageBrowserPolicy.shouldLog'
    package: '@azure/storage-queue'
    summary: Get whether or not a log with the provided log level should be logged.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function shouldLog(logLevel: HttpPipelineLogLevel): boolean'
      parameters:
        - id: logLevel
          type: <xref uid="@azure/core-http-compat.HttpPipelineLogLevel" />
          description: The log level of the log that will be logged.
      return:
        description: Whether or not a log with the provided log level should be logged.
        type: boolean
    inheritanceDescription: >-
      <b>Inherited From</b>
      [BaseRequestPolicy.shouldLog](xref:@azure/storage-queue.BaseRequestPolicy.shouldLog)
methods:
  - name: sendRequest(WebResourceLike)
    uid: '@azure/storage-queue.StorageBrowserPolicy.sendRequest'
    package: '@azure/storage-queue'
    summary: Sends out request.
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'function sendRequest(request: WebResourceLike): Promise<CompatResponse>'
      parameters:
        - id: request
          type: <xref uid="@azure/storage-queue.WebResource" />
          description: ''
      return:
        description: ''
        type: >-
          Promise&lt;<xref uid="@azure/storage-queue.HttpOperationResponse"
          />&gt;
extends: <xref uid="@azure/storage-queue.BaseRequestPolicy" />