Class ZCookieBuilder

constructor

• new ZCookieBuilder(): ZCookieBuilder

  Initializes a new instance of this object.

  Returns ZCookieBuilder

immortal

lax

strict

Static ReadonlyMillisecondsOneDay

allowCrossSite

• allowCrossSite(): this

  Sets the same site policy to 'none' and turns on the secure flag.

  Returns this

  This object.

authentication

• authentication(token?: string): this

  Creates a token based authentication cookie.

  Parameters

  • Optionaltoken: string

    The token value for the cookie. You can leave this as undefined to set it later.

  Returns this

  This object.

build

• build(): IZCookie

  Returns a copy of the built instance of the cookie.

  Returns IZCookie

  A shallow copy of the current cookie object.

domain

• domain(val: string | undefined): this

  Sets the cookie domain.

  Parameters

  • val: string | undefined

    The value to set.

  Returns this

  This object.

expires

• expires(val: string | Date | undefined): this

  Sets the cookie expiration date.

  Parameters

  • val: string | Date | undefined

    The value to set.

  Returns this

  This object.

expiresTomorrow

• expiresTomorrow(): this

  Sets the cookie expiration date to one day from the moment this is invoked.

  Returns this

  This object.

httpOnly

• httpOnly(val?: boolean): this

  Sets the cookie http only flag.

  Parameters

  • val: boolean = true

    The value to set.

  Returns this

  This object.

name

• name(val: string): this

  Sets the cookie name.

  Parameters

  • val: string

    The value to set.

  Returns this

  This object.

sameSite

• sameSite(val: "lax" | "strict" | "none"): this

  Sets the cookie same site policy.

  Parameters

  • val: "lax" | "strict" | "none"

    The value to set.

  Returns this

  This object.

secure

• secure(val?: boolean): this

  Sets the cookie secure flag.

  Parameters

  • val: boolean = true

    The value to set.

  Returns this

  This object.

value

• value(val: string): this

  Sets the cookie value.

  Parameters

  • val: string

    The value to set.

  Returns this

  This object.