Class CookieService

High-level API for reading, writing, serializing, and removing browser cookies through the injectable $cookie service.

Index

Constructors

constructor

Methods

get getAll getObject put putObject remove

Constructors

constructor

new CookieService(defaults: CookieOptions): CookieService
Accepts the default cookie attributes defined by $cookiesProvider.defaults.
Parameters
- defaults: CookieOptions
Returns CookieService

Methods

get

get(key: string): string | null
Retrieves a raw cookie value.
Parameters
- key: string
  
  Cookie name to read.
Returns string | null

The decoded cookie value, or null when not set.

Throws

– If decodeURIComponent fails.

getAll

getAll(): Record<string, string>

Returns an object containing all raw cookies.

Returns Record<string, string>

Throws

– If decodeURIComponent fails

getObject

getObject(key: string): unknown
Retrieves a cookie and deserializes its JSON content.
Parameters
- key: string
  
  Cookie name to read.
Returns unknown

The parsed value, or null when not set.

Throws

if cookie JSON is invalid

put

put(key: string, value: string, options?: CookieOptions): void
Sets a raw cookie value.
Parameters
- key: string
  
  Cookie name to write.
- value: string
  
  String value to write.
- options: CookieOptions = {}
  
  Cookie attributes for this write.
Returns void

Throws

if key or value cannot be encoded

putObject

putObject(key: string, value: unknown, options?: CookieOptions): void
Serializes an object as JSON and stores it as a cookie.
Parameters
- key: string
  
  Cookie name to write.
- value: unknown
  
  JSON-serializable value.
- Optionaloptions: CookieOptions
  
  Cookie attributes for this write.
Returns void

Throws

if Object cannot be converted to JSON

remove

remove(key: string, options?: CookieOptions): void
Removes a cookie by setting an expired date.
Parameters
- key: string
  
  Cookie name to remove.
- options: CookieOptions = {}
  
  Cookie attributes that must match the existing cookie.
Returns void

Settings

Member Visibility

Theme