Class Cookie

Hierarchy

Cookie

Index

Constructors

Properties

_get _set name separator

Methods

clear copy deserialize get has remove serialize set toCookieItemKey toDocumentCookieName

Constructors

constructor

new Cookie(name, get, set, separator?): Cookie
Parameters
- name: string
- get: (() => string)
  - - (): string
    - Returns string
- set: ((cookies) => void)
  - - (cookies): void
    - Parameters
      
      cookies: string
      
      Returns void
- separator: string = DEFAULT_COOKIE_SEPARATOR
Returns Cookie
- Defined in src/modules/cookie.ts:20

Properties

`Private` `Readonly` _get

_get: (() => string | Error)

Type declaration

- (): string | Error
- Returns string | Error

`Private` `Readonly` _set

_set: ((cookies) => void | Error)

Type declaration

- (cookies): void | Error
- Parameters
  - cookies: string
  Returns void | Error

name

name: string

separator

separator: string = DEFAULT_COOKIE_SEPARATOR

Methods

clear

clear(options?): void | Error
Parameters
- options: CookieSerializeOptions = {}
Returns void | Error
- Defined in src/modules/cookie.ts:28

copy

copy<T1, T2, T>(key, target, keys?): void | Error
Type Parameters
- T1 extends CookieItem
- T2 extends CookieItem = CookieItem
- T extends CookieItem = T1 & T2
Parameters
- key: string
- target: T2
- Optional keys: (keyof T)[]
Returns void | Error
- Defined in src/modules/cookie.ts:122

`Private` deserialize

deserialize(options?): Error | CookieObject
Parameters
- Optional options: CookieParseOptions
Returns Error | CookieObject
- Defined in src/modules/cookie.ts:183

get

get<T>(key): Error | T
Type Parameters
- T extends CookieItem
Parameters
- key: string
Returns Error | T
- Defined in src/modules/cookie.ts:47

has

has<T>(key, keys?): boolean
Type Parameters
- T extends CookieItem
Parameters
- key: string
- Optional keys: (keyof T)[]
Returns boolean
- Defined in src/modules/cookie.ts:154

remove

remove<T>(key, options?, keys?): void | Error
Type Parameters
- T extends CookieItem
Parameters
- key: string
- options: CookieSerializeOptions = {}
- Optional keys: (keyof T)[]
Returns void | Error
- Defined in src/modules/cookie.ts:70

`Private` serialize

serialize(key, value, options?): string | Error
Parameters
- key: string
- value: string
- Optional options: CookieSerializeOptions
Returns string | Error
- Defined in src/modules/cookie.ts:192
serialize<T>(key, ik, value, options?): string | Error
Type Parameters
- T extends CookieItem
Parameters
- key: string
- ik: keyof T
- value: Primitive
- Optional options: CookieSerializeOptions
Returns string | Error
- Defined in src/modules/cookie.ts:193

set

set<T>(key, item, options?, keys?): void | Error
Type Parameters
- T extends CookieItem
Parameters
- key: string
- item: T
- options: CookieSerializeOptions = {}
- Optional keys: (keyof T)[]
Returns void | Error
- Defined in src/modules/cookie.ts:103

`Private` toCookieItemKey

toCookieItemKey<T>(key, ik): string
Type Parameters
- T extends CookieItem
Parameters
- key: string
- ik: keyof T
Returns string
- Defined in src/modules/cookie.ts:205

`Private` toDocumentCookieName

toDocumentCookieName<T>(key, ik): string
Type Parameters
- T extends CookieItem
Parameters
- key: string
- ik: keyof T
Returns string
- Defined in src/modules/cookie.ts:209

Generated using TypeDoc