Class CookieService

Provides high-level APIs for interacting with browser cookies:

Raw get/set/remove
JSON serialization helpers
Global defaults supplied by $cookiesProvider

Index

Constructors

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
Returns string | null
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<T>(key: string): T | null
Retrieves a cookie and deserializes its JSON content.
Type Parameters
- T
Parameters
- key: string
Returns T | null
Throws
if cookie JSON is invalid

put

put(key: string, value: string, options?: CookieOptions): void
Sets a raw cookie value.
Parameters
- key: string
- value: string
- options: CookieOptions = {}
Returns void
Throws
if key or value cannot be encoded

putObject

putObject(key: string, value: any, options?: CookieOptions): void
Serializes an object as JSON and stores it as a cookie.
Parameters
- key: string
- value: any
- Optionaloptions: CookieOptions
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
- options: CookieOptions = {}
Returns void