Class CookieStorage

Provides a generic interface for interacting with Cookies

Implements

IGenericStorage

Index

Constructors

Properties

mainDocument serializer

Methods

Get GetValue Remove Set SetValue

Constructors

constructor

new CookieStorage(serializer?, mainDocument?): CookieStorage
Parameters
- serializer: JsonSerializer = ...
- mainDocument: Document = document
Returns CookieStorage
- Defined in src/Persistence/GenericStorage/CookieStorage.ts:30

Properties

`Private` mainDocument

mainDocument: Document = document

`Private` serializer

serializer: JsonSerializer = ...

Methods

Get

Get<T>(type, key): Result<T>
Uses stored data to return a class instance of the type specified
Type Parameters
- T
Parameters
- type: (new () => T)
  - - new (): T
    - Returns T
- key: string
Returns Result<T>
Implementation of IGenericStorage.Get
- Defined in src/Persistence/GenericStorage/CookieStorage.ts:35

GetValue

GetValue(key): Result<string>
Returns the raw data stored at the given key
Parameters
- key: string
Returns Result<string>
Implementation of IGenericStorage.GetValue
- Defined in src/Persistence/GenericStorage/CookieStorage.ts:52

Remove

Remove(key, path?, domain?): Result<null>
Delete the item with the given key from storage
Parameters
- key: string
- path: string = '/'
- Optional domain: string
Returns Result<null>
Implementation of IGenericStorage.Remove
- Defined in src/Persistence/GenericStorage/CookieStorage.ts:82

Set

Set<T>(key, value, options?): Result<null>
Stores the stringified version of the given object at the specified key
Type Parameters
- T
Parameters
- key: string
- value: T
- Optional options: CookieOptions
Returns Result<null>
Implementation of IGenericStorage.Set
- Defined in src/Persistence/GenericStorage/CookieStorage.ts:46

SetValue

SetValue(key, value, options?): Result<null>
Stores the raw data of the given value at the given key
Parameters
- key: string
- value: string
- options: CookieOptions = ...
Returns Result<null>
Implementation of IGenericStorage.SetValue
- Defined in src/Persistence/GenericStorage/CookieStorage.ts:65

Generated using TypeDoc