Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Cookie

Hierarchy

  • Cookie

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    Returns Cookie

Properties

creation

creation: null | Date

creationIndex

creationIndex: number

domain

domain: null | string

expires

expires: Date | "Infinity"

extensions

extensions: null | string[]

hostOnly

hostOnly: null | boolean

httpOnly

httpOnly: boolean

key

key: string

lastAccessed

lastAccessed: null | Date

maxAge

maxAge: number | "Infinity" | "-Infinity"

path

path: null | string

pathIsDefault

pathIsDefault: null | boolean

sameSite

sameSite: string

secure

secure: boolean

value

value: string

Methods

TTL

  • TTL(now?: Date): number

  • Parameters

    • Optional now: Date

    Returns number

canonicalizedDomain

  • canonicalizedDomain(): null | string

  • Returns null | string

cdomain

  • cdomain(): null | string

  • Returns null | string

clone

  • Returns Cookie

cookieString

  • cookieString(): string

  • Returns string

expiryDate

  • expiryDate(now?: number): Date

  • Parameters

    • Optional now: number

    Returns Date

expiryTime

  • expiryTime(now?: number): number

  • Parameters

    • Optional now: number

    Returns number

inspect

  • inspect(): string

  • Returns string

isPersistent

  • isPersistent(): boolean

  • Returns boolean

setExpires

  • setExpires(exp: string | Date): void

  • Parameters

    • exp: string | Date

    Returns void

setMaxAge

  • setMaxAge(number: number): void

  • Parameters

    • number: number

    Returns void

toJSON

  • toJSON(): {}

  • Returns {}

    • [key: string]: any

toString

  • toString(): string

  • Returns string

validate

  • validate(): string | boolean

  • Returns string | boolean

Static fromJSON

  • fromJSON(strOrObj: string | object): null | Cookie

  • Parameters

    • strOrObj: string | object

    Returns null | Cookie

Static parse

  • Parameters

    Returns undefined | Cookie

Generated using TypeDoc