Options
All
  • Public
  • Public/Protected
  • All
Menu

HttpCookie

Represents a RFC 6265 cookie.

Hierarchy

  • HttpCookie

Index

Constructors

constructor

  • new HttpCookie(name: string, value: string, path?: undefined | string, domain?: undefined | string, expires?: undefined | string, maxAge?: undefined | number, secure?: undefined | false | true, httpOnly?: undefined | false | true): HttpCookie
  • Constructs a new fully specified cookie.

    Parameters

    • name: string

      the name of the cookie.

    • value: string

      the value of the cookie.

    • Optional path: undefined | string

      the path within the domain to which this cookie belongs.

    • Optional domain: undefined | string

      the domain to which this cookie belongs.

    • Optional expires: undefined | string

      when the cookie expires.

    • Optional maxAge: undefined | number

      how long the cookie can live for.

    • Optional secure: undefined | false | true

      whether or not this cookie can only be sent to HTTPS servers.

    • Optional httpOnly: undefined | false | true

      whether or not this cookie can only be read by a server.

    Returns HttpCookie

Properties

Optional domain

domain: undefined | string

the domain to which this cookie belongs.

Optional expires

expires: undefined | string

when the cookie expires.

Optional httpOnly

httpOnly: undefined | false | true

whether or not this cookie can only be read by a server.

Optional maxAge

maxAge: undefined | number

how long the cookie can live for.

name

name: string

the name of the cookie.

Optional path

path: undefined | string

the path within the domain to which this cookie belongs.

Optional secure

secure: undefined | false | true

whether or not this cookie can only be sent to HTTPS servers.

value

value: string

the value of the cookie.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc