Skip to main content

Interface: WebResponseHeaders

@divine/web-service.WebResponseHeaders

Definitions of all known HTTP response headers.

Properties

accept-patch

Optional accept-patch: string | ContentType

Specifies which patch document formats this server supports.

Defined in

web-service/src/response.ts:143


accept-ranges

Optional accept-ranges: string

What partial content range types this server supports via byte serving.

Defined in

web-service/src/response.ts:146


access-control-allow-credentials

Optional access-control-allow-credentials: string | boolean

CORS: Indicates whether the response can be shared when request's credentials mode is "include".

Defined in

web-service/src/response.ts:149


access-control-allow-headers

Optional access-control-allow-headers: string | string[]

CORS: Indicates which headers are supported by the response's URL.

Defined in

web-service/src/response.ts:152


access-control-allow-methods

Optional access-control-allow-methods: string | string[]

CORS: Indicates which methods are supported by the response's URL.

Defined in

web-service/src/response.ts:155


access-control-allow-origin

Optional access-control-allow-origin: string | URL

CORS: Indicates whether the response can be shared, via returning the literal value of the Origin request header (which can be null) or * in a response.

Defined in

web-service/src/response.ts:158


access-control-expose-headers

Optional access-control-expose-headers: string | string[]

CORS: Indicates which headers can be exposed as part of the response by listing their names.

Defined in

web-service/src/response.ts:161


access-control-max-age

Optional access-control-max-age: string | number

CORS: Indicates the number of seconds (5 by default) the information provided by the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers can be cached.

Defined in

web-service/src/response.ts:164


age

Optional age: string | number

The age the object has been in a proxy cache in seconds.

Defined in

web-service/src/response.ts:167


allow

Optional allow: string | string[]

Valid methods for a specified resource.

Defined in

web-service/src/response.ts:170


alt-svc

Optional alt-svc: string

A server uses "Alt-Svc" header (meaning Alternative Services) to indicate that its resources can also be accessed at a different network location (host or port) or using a different protocol.

Defined in

web-service/src/response.ts:173


cache-control

Optional cache-control: string

Tells all caching mechanisms from server to client whether they may cache this object.

Defined in

web-service/src/response.ts:176


connection

Optional connection: string

Control options for the current connection and list of hop-by-hop response fields.

Defined in

web-service/src/response.ts:179


content-disposition

Optional content-disposition: string | ContentDisposition

An opportunity to raise a "File Download" dialogue box for a known MIME type with binary format or suggest a filename for dynamic content.

Defined in

web-service/src/response.ts:182


content-encoding

Optional content-encoding: string | string[]

The type of encoding used on the data.

Defined in

web-service/src/response.ts:185


content-language

Optional content-language: string

The natural language or languages of the intended audience for the enclosed content.

Defined in

web-service/src/response.ts:188


content-length

Optional content-length: string | number

The length of the response body in octets.

Defined in

web-service/src/response.ts:191


content-location

Optional content-location: string | URL

An alternate location for the returned data.

Defined in

web-service/src/response.ts:194


content-md5

Optional content-md5: string

A Base64-encoded binary MD5 sum of the content of the response.

Defined in

web-service/src/response.ts:197


content-range

Optional content-range: string

Where in a full body message this partial message belongs.

Defined in

web-service/src/response.ts:200


content-security-policy

Optional content-security-policy: string

Content Security Policy definition.

Defined in

web-service/src/response.ts:203


content-type

Optional content-type: string | ContentType

The MIME type of this content.

Defined in

web-service/src/response.ts:206


date

Optional date: string | Date

The date and time that the message was sent.

Defined in

web-service/src/response.ts:209


delta-base

Optional delta-base: string

Specifies the delta-encoding entity tag of the response.

Defined in

web-service/src/response.ts:212


etag

Optional etag: string

An identifier for a specific version of a resource, often a message digest.

Defined in

web-service/src/response.ts:215


expect-ct

Optional expect-ct: string

Notify to prefer to enforce Certificate Transparency.

Defined in

web-service/src/response.ts:221


expires

Optional expires: string | Date

Gives the date/time after which the response is considered stale.

Defined in

web-service/src/response.ts:218


im

Optional im: string

Instance-manipulations applied to the response.

Defined in

web-service/src/response.ts:224


last-modified

Optional last-modified: string | Date

The last modified date for the requested object.

Defined in

web-service/src/response.ts:227


Optional link: string

Used to express a typed relationship with another resource.

Defined in

web-service/src/response.ts:230


location

Optional location: string | URL

Used in redirection, or when a new resource has been created.

Defined in

web-service/src/response.ts:233


nel

Optional nel: string

Used to configure network request logging.

Defined in

web-service/src/response.ts:236


p3p

Optional p3p: string

This field is supposed to set P3P policy.

Defined in

web-service/src/response.ts:239


permissions-policy

Optional permissions-policy: string

To allow or disable different features or APIs of the browser.

Defined in

web-service/src/response.ts:245


pragma

Optional pragma: string

Implementation-specific fields that may have various effects anywhere along the request-response chain.

Defined in

web-service/src/response.ts:242


preference-applied

Optional preference-applied: string

Indicates which Prefer tokens were honored by the server and applied to the processing of the request.

Defined in

web-service/src/response.ts:248


proxy-authenticate

Optional proxy-authenticate: string | WWWAuthenticate | WWWAuthenticate[]

Request authentication to access the proxy.

Defined in

web-service/src/response.ts:251


public-key-pins

Optional public-key-pins: string

HTTP Public Key Pinning, announces hash of website's authentic TLS certificate.

Defined in

web-service/src/response.ts:254


refresh

Optional refresh: string | number | Date

Used in redirection, or when a new resource has been created.

Defined in

web-service/src/response.ts:257


report-to

Optional report-to: string

Instructs the user agent to store reporting endpoints for an origin.

Defined in

web-service/src/response.ts:260


retry-after

Optional retry-after: string | number | Date

If an entity is temporarily unavailable, this instructs the client to try again later.

Defined in

web-service/src/response.ts:263


server

Optional server: string

A name for the server.

Defined in

web-service/src/response.ts:266


Optional set-cookie: string

An HTTP cookie.

Defined in

web-service/src/response.ts:269


strict-transport-security

Optional strict-transport-security: string

A HSTS Policy informing the HTTP client how long to cache the HTTPS only policy and whether this applies to subdomains.

Defined in

web-service/src/response.ts:272


timing-allow-origin

Optional timing-allow-origin: string | string[]

The Timing-Allow-Origin response header specifies origins that are allowed to see values of attributes retrieved via features of the Resource Timing API, which would otherwise be reported as zero due to cross-origin restrictions.

Defined in

web-service/src/response.ts:275


tk

Optional tk: string

Tracking Status header, value suggested to be sent in response to a DNT(do-not-track).

Defined in

web-service/src/response.ts:278


trailer

Optional trailer: string | string[]

The Trailer general field value indicates that the given set of header fields is present in the trailer of a message encoded with chunked transfer coding.

Defined in

web-service/src/response.ts:281


transfer-encoding

Optional transfer-encoding: string | string[]

The form of encoding used to safely transfer the entity to the user.

Defined in

web-service/src/response.ts:284


upgrade

Optional upgrade: string | string[]

Ask the client to upgrade to another protocol.

Defined in

web-service/src/response.ts:287


vary

Optional vary: string | string[]

Tells downstream proxies how to match future request headers to decide whether the cached response can be used rather than requesting a fresh one from the origin server.

Defined in

web-service/src/response.ts:290


via

Optional via: string | string[]

Informs the client of proxies through which the response was sent.

Defined in

web-service/src/response.ts:293


warning

Optional warning: string

A general warning about possible problems with the entity body.

Defined in

web-service/src/response.ts:296


www-authenticate

Optional www-authenticate: string | WWWAuthenticate | WWWAuthenticate[]

Indicates the authentication scheme that should be used to access the requested entity.

Defined in

web-service/src/response.ts:299


x-content-duration

Optional x-content-duration: string | number

Provide the duration of the audio or video in seconds; only supported by Gecko browsers.

Defined in

web-service/src/response.ts:302


x-content-security-policy

Optional x-content-security-policy: string

Content Security Policy definition.

Defined in

web-service/src/response.ts:305


x-content-type-options

Optional x-content-type-options: string

The only defined value, "nosniff", prevents Internet Explorer from MIME-sniffing a response away from the declared content-type.

Defined in

web-service/src/response.ts:308


x-correlation-id

Optional x-correlation-id: string

Correlates HTTP requests between a client and server.

Defined in

web-service/src/response.ts:311


x-frame-options

Optional x-frame-options: string

Clickjacking protection.

Defined in

web-service/src/response.ts:314


x-powered-by

Optional x-powered-by: string

Specifies the technology (e.g. ASP.NET, PHP, JBoss) supporting the web application.

Defined in

web-service/src/response.ts:317


x-redirect-by

Optional x-redirect-by: string

Specifies the component that is responsible for a particular redirect.

Defined in

web-service/src/response.ts:320


x-request-id

Optional x-request-id: string

Correlates HTTP requests between a client and server.

Defined in

web-service/src/response.ts:323


x-ua-compatible

Optional x-ua-compatible: string

Recommends the preferred rendering engine (often a backward-compatibility mode) to use to display the content.

Defined in

web-service/src/response.ts:326


x-webkit-csp

Optional x-webkit-csp: string

Content Security Policy definition.

Defined in

web-service/src/response.ts:329


x-xss-protection

Optional x-xss-protection: string

Cross-site scripting (XSS) filter.

Defined in

web-service/src/response.ts:332