cookie - Buntal JS

Utility object for managing HTTP cookies in Buntal applications.

Source

Type Definition

const cookie = {
  get: (req: Req, name: string) => string | null
  getAll: (req: Req) => Record<string, string>
  set: (res: Res, name: string, value: string, options?: CookieOptions) => string
  delete: (res: Res, name: string) => string
}

Methods

get

Retrieves a specific cookie value from the request.

Parameters

Parameter	Type	Required	Default	Description
`req`	`Req`	✅	-	Request object
`name`	`string`	✅	-	Cookie name

Returns

string | null

getAll

Retrieves all cookies from the request as an object.

Parameters

Parameter	Type	Required	Default	Description
`req`	`Req`	✅	-	Request object

Returns

Record<string, string>

set

Sets a cookie in the response.

Parameters

Parameter	Type	Required	Default	Description
`res`	`Res`	✅	-	Response object
`name`	`string`	✅	-	Cookie name
`value`	`string`	✅	-	Cookie value
`options`	`CookieOptions`	❌	-	Cookie configuration options

Returns

string

delete

Deletes a cookie by setting its expiry to the past.

Parameters

Parameter	Type	Required	Default	Description
`res`	`Res`	✅	-	Response object
`name`	`string`	✅	-	Cookie name to delete

Returns

string