Class: MIMEHeader

vertx-web-js/mime_header~ MIMEHeader

new MIMEHeader()

Source:

Methods

component() → {string}

Gets the parsed component part of the MIME. This is the string between the beginning and the first @{code '/'} of the MIME
Source:
Returns:
The component of the MIME this represents
Type
string

isMatchedBy(matchTry) → {boolean}

Test if this header is matched by matchTry header
Parameters:
Name Type Description
matchTry ParsedHeaderValue The header to be matched from
Source:
Returns:
true if this header represents a subset of matchTry, otherwise, false
Type
boolean

isPermitted() → {boolean}

Is this an allowed operation as specified by the corresponding header?
Source:
Returns:
Type
boolean

parameter(key) → {string}

The value of the parameter specified by this key. Each is one of 3 things:
  1. null <- That key was not specified
  2. ParsedHeaderValue.EMPTY (tested using ==) <- The value was not specified
  3. [Other] <- The value of the parameter
Note: The q parameter is never present.
Parameters:
Name Type Description
key string
Source:
Returns:
Type
string

parameters() → {Array.<string>}

The parameters specified in this header value. Note: The q parameter is never present.
Source:
Returns:
Unmodifiable Map of parameters of this header value
Type
Array.<string>

rawValue() → {string}

Contains the raw value that was received from the user agent
Source:
Returns:
Type
string

subComponent() → {string}

Gets the parsed subcomponent part of the MIME. This is the string between the first @{code '/'} and the
Source:
Returns:
The subcomponent of the MIME this represents
Type
string

value() → {string}

Holds the unparsed value of the header.
For the most part, this is the content before the semi-colon (";")
Source:
Returns:
Type
string

weight() → {number}

Holds the weight specified in the "q" parameter of the header.
If the parameter is not specified, 1.0 is assumed according to rfc7231
Source:
Returns:
Type
number

weightedOrder() → {number}

An integer that represents the absolute order position of this header
Source:
Returns:
Type
number