dioio-io
1/20/2020 - 12:43 PM

http-headers.enum.ts

export enum Headers {
  /**
   * Instance manipulations that are acceptable in the response. Defined in RFC 3229
   * @example 'A-IM': 'feed'
   */
  A_IM = 'AM_I',
  /**
   * The media type/types acceptable
   * @example 'Accept': 'application/json'
   */
  ACCEPT = 'Accept',
  /**
   * The charset acceptable
   * @example 'Accept-Charset': 'utf-8'
   */
  ACCEPT_CHARSET = 'Accept-Charset',
  /**
   * List of acceptable encodings
   * @example 'Accept-Encoding': 'gzip, deflate'
   */
  ACCEPT_ENCODING = 'Accept-Encoding',
  /**
   * List of acceptable languages
   * @example 'Accept-Language': 'en-US'
   */
  ACCEPT_LANGUAGE = 'Accept-Language',
  /**
   * Request a past version of the resource prior to the datetime passed
   * @example 'Accept-Datetime': 'Thu, 31 May 2007 20:35:00 GMT'
   */
  ACCEPT_DATETIME = 'Accept-Datetime',
  /**
   * Used in a CORS request
   * @example 'Access-Control-Request-Method': GET
  */
  ACCESS_CONTROL_REQUEST_METHOD = 'Access-Control-Request-Method',
  /**
   * Used in a CORS request
   * @example 'Access-Control-Request-Headers': 'origin, x-requested-with, accept'
   */
  ACCESS_CONTROL_REQUEST_HEADERS = 'Access-Control-Request-Headers',
  /**
   * HTTP basic authentication credentials
   * @example 'Authorization': 'Basic 34i3j4iom2323=='
   */
  AUTHORIZATION = 'Authorization',
  /**
   * Set the caching rules
   * @example 'Cache-Control': 'no-cache'
   */
  CACHE_CONTROL = 'Cache-Control',
  /**
   * Control options for the current connection. Accepts keep-alive and close.
   * @deprecated Deprecated in HTTP/2
   * @example 'Connection': 'keep-alive'
   */
  CONNECTION = 'Connection',
  /**
   * The length of the request body in bytes
   * @example 'Content-Length': 348
   */
  CONTENT_LENGTH = 'Content-Length',
  /**
   * The content type of the body of the request (used in POST and PUT requests).
   * @example 'Content-Type': 'application/x-www-form-urlencoded'
   */
  CONTENT_TYPE = 'Content-Type',
  /**
   * @example 'Cookie': 'name=value'
   */
  COOKIE = 'Cookie',
  /**
   * The date and time that the request was sent
   * @example 'Date': 'Tue, 15 Nov 1994 08:12:31 GMT'
   */
  DATE = 'Date',
  /**
   * It’s typically used when sending a large request body.
   * We expect the server to return back a 100 Continue HTTP status if it can handle the request, or 417 Expectation Failed if not
   * @example 'Expect': '100-continue'
  */
  EXPECT = 'Except',
  /**
   * Disclose original information of a client connecting to a web server through an HTTP proxy. Used for testing purposes only, as it discloses privacy sensitive information
   * @example 'Forwarded': 'for=192.0.2.60; proto=http; by=203.0.113.43'
   */
  FORWARDED = 'Forwarded',
  /**
   * The email address of the user making the request. Meant to be used, for example, to indicate a contact email for bots.
   * @example 'From': 'user@example.com'
   */
  FROM = 'From',
  /**
   * The domain name of the server (used to determined the server with virtual hosting),
   * and the TCP port number on which the server is listening.
   * If the port is omitted, 80 is assumed. This is a mandatory HTTP request header
   * @example 'Host': 'flaviocopes.com'
   */
  HOST = 'Host',
  /**
   * Given one (or more) ETags, the server should only send back the response if the current resource matches one of those ETags.
   * Mainly used in PUT methods to update a resource only if it has not been modified since the user last updated it
   * @example 'If-Match': "737060cd8c284d8582d"
   */
  IF_MATCH = 'If-Match',
  /**
   * Allows to return a 304 Not Modified response header if the content is unchanged since that date
   * @example 'If-Modified-Since': 'Sat, 29 Oct 1994 19:43:31 GMT'
   */
  IF_MODIFIED_SINCE = 'If-Modified-Since',
  /**
   * Allows a 304 Not Modified response header to be returned if content is unchanged. Opposite of If-Match.
   * @example 'If-None-Match': "737060cd882f209582d"
  */
  IF_NONE_MATCH = 'If-None-Match',
  /**
   * Used to resume downloads, returns a partial if the condition is matched (ETag or date) or the full resource if not.
   * @example 'If-Range': '737060cd8c9582d'
   */
  IF_RANGE = 'If-Range',
  /**
   * Only send the response if the entity has not been modified since the specified time
   * @example 'If-Unmodified-Since': 'Sat, 29 Oct 1994 19:43:31 GMT'
   */
  IF_UNMODIFIED_SINCE = 'If_Unmodified_Since',
  /**
   * Limit the number of times the message can be forwarded through proxies or gateways
   * @example 'Max-Forwards': 10
   */
  MAX_FORWARDS = 'Max-Forwards',
  /**
   * Send the current domain to perform a CORS request, used in an OPTIONS HTTP request (to ask the server for Access-Control- response headers)
   * @example Origin: http://example.com
   */
  ORIGIN = 'Origin',
  /**
   * Used for backwards compatibility with HTTP/1.0 caches
   * @example Pragma: no-cache
   */
  PRAGMA = 'Pragma',
  /**
   * Authorization credentials for connecting to a proxy
   * @example 'Proxy-Authorization': 'Basic 2323jiojioIJOIOJIJ=='
   */
  PROXY_AUTHORIZATION = 'Proxy-Authorization',
  /**
   * Request only a specific part of a resource
   * @example 'Range': 'bytes=500-999'
   */
  RANGE = 'Range',
  /**
   * The address of the previous web page from which a link to the currently requested page was followed.
   * @example 'Referer': 'https://example.com'
   */
  REFERER = 'Referer',
  /**
   * Specify the encodings the client can accept.
   * Accepted values: compress, deflate, gzip, trailers. Only trailers is supported in HTTP/2
   * @example 'TE': 'trailers, deflate'
   */
  TE = 'TE',
  /**
   * The string that identifies the user agent
   * @example 'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/67.0.3396.99 Safari/537.36'
   */
  USER_AGENT = 'User-Agent',
  /**
   * Ask the server to upgrade to another protocol.
   * @deprecated Deprecated in HTTP/2
   * @example 'Upgrade': 'h2c, HTTPS/1.3, IRC/6.9, RTA/x11, websocket'
   */
  UPGRADE = 'Upgrade',
  /**
   * Informs the server of proxies through which the request was sent
   * @example 'Via': '1.0 fred, 1.1 example.com (Apache/1.1)'
  */
  VIA = 'Via',
  /**
   * A general warning about possible problems with the status of the message. Accepts a special range of values.
   * @example 'Warning': '199 Miscellaneous warning'
   */
  WARNING = 'Warning',
  /**
   * Non-standard
   * If enabled, asks servers to not track the user
   * @example 'DNT': 1
  */
  DNT = 'Dnt',
  /**
   * Non-standard
   * Identifies XHR requests
   * @example 'X-Requested-With': 'XMLHttpRequest'
   */
  X_REQUEST_WITH = 'X-Requested-With',
  /**
   * Non-standard
   * Used to prevent CSRF
   * @example 'X-CSRF-Token': '<TOKEN>'
  */
  X_CSRF_TOKEN = 'X-CSRF-Token',
  /**
   * Non-standard
   * API version
   * @example 'X-Version': '1.0.0'
  */
  X_VERSION = 'X-Version',
}