Class Cookie

Constructors

constructor

Properties

domain expires httpOnly path sameSite secure value

Constructors

constructor

  • new Cookie(value, data?): Cookie

  • Create a new Cookie

    Parameters

    • value: Content
    • Optional data: CookieData

    Returns Cookie

    Example

    import { Cookie } from "rjweb-server"

    const cookie = new Cookie('value', {
      expires: 50000
    })

    Since

    9.0.0

Properties

Readonly domain

domain: null | string

The Domain this Cookie will be assigned to.

If not provided will not be used in the Cookie Header.

Default

null

See

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes

Since

9.0.0

Readonly expires

expires: null | number | Date

The Date or seconds in which the Cookie will expire

If not provided will create a "Session Cookie".

Default

null

See

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes

Since

9.0.0

Readonly httpOnly

httpOnly: boolean

Whether the Cookie should be HTTP only

Default

false

See

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes

Since

9.0.0

Readonly path

path: string

The Path under which to save the Cookie

Default

"/"

See

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes

Since

9.0.0

Readonly sameSite

sameSite: false | "none" | "strict" | "lax"

The SameSite Attribute of the Cookie

Default

false

See

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes

Since

9.0.0

Readonly secure

secure: boolean

Whether the Cookie should be Secure (HTTPS only)

Default

false

See

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes

Since

9.0.0

Readonly value

value: Content

The Value of the Cookie

See

https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#attributes

Since

9.0.0

Settings

Member Visibility

Theme

On This Page

constructordomainexpireshttpOnlypathsameSitesecurevalue