Class Cookie

A Cookie represents an HTTP cookie as sent in the Set-Cookie header of an HTTP response.

Example:

routerAdd("POST", "/example", (c) => {
    c.setCookie(new Cookie({
        name:     "example_name",
        value:    "example_value",
        path:     "/",
        domain:   "example.com",
        maxAge:   10,
        secure:   true,
        httpOnly: true,
        sameSite: 3,
    }))

    return c.redirect(200, "/");
})

Hierarchy

Implements

Constructors

constructor

Methods

string valid

Properties

domain expires httpOnly maxAge name partitioned path quoted raw rawExpires sameSite secure unparsed value

Constructors

constructor

Methods

string

  • String returns the serialization of the cookie for use in a [Cookie] header (if only Name and Value are set) or a Set-Cookie response header (if other fields are set). If c is nil or c.Name is invalid, the empty string is returned.

    Returns string

valid

Properties

domain

domain: string

expires

expires: Time

httpOnly

httpOnly: boolean

maxAge

maxAge: number

MaxAge=0 means no 'Max-Age' attribute specified. MaxAge<0 means delete cookie now, equivalently 'Max-Age: 0' MaxAge>0 means Max-Age attribute present and given in seconds

name

name: string

partitioned

partitioned: boolean

path

path: string

quoted

quoted: boolean

raw

raw: string

rawExpires

rawExpires: string

sameSite

sameSite: SameSite

secure

secure: boolean

unparsed

unparsed: string[]

value

value: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc