Class LocalStorage

Hierarchy

LocalStorage

Implements

IWindowStorage<string>

Index

Constructors

Methods

clear containsKey getItem getKeys getUserData initialize removeItem setItem setUserData

Constructors

constructor

new LocalStorage(clientId, logger, performanceClient): LocalStorage
Parameters
- clientId: string
- logger: Logger
- performanceClient: IPerformanceClient
Returns LocalStorage
- Defined in msal-browser/src/cache/LocalStorage.ts:61

Methods

clear

clear(): void
Removes all known MSAL keys from the cache

Returns void
- Defined in msal-browser/src/cache/LocalStorage.ts:238

containsKey

containsKey(key): boolean
Returns true or false if the given key is present in the cache.
Parameters
- key: string
Returns boolean
Implementation of IWindowStorage.containsKey
- Defined in msal-browser/src/cache/LocalStorage.ts:231

getItem

getItem(key): null | string
Get the item from the window storage object matching the given key.
Parameters
- key: string
Returns null | string
Implementation of IWindowStorage.getItem
- Defined in msal-browser/src/cache/LocalStorage.ts:163

getKeys

getKeys(): string[]
Get all the keys from the window storage object as an iterable array of strings.

Returns string[]
Implementation of IWindowStorage.getKeys
- Defined in msal-browser/src/cache/LocalStorage.ts:227

getUserData

getUserData(key): null | string
Getter for sensitive data that may contain PII.
Parameters
- key: string
Returns null | string
Implementation of IWindowStorage.getUserData
- Defined in msal-browser/src/cache/LocalStorage.ts:167

initialize

initialize(correlationId): Promise<void>
Async initializer
Parameters
- correlationId: string
Returns Promise<void>
Implementation of IWindowStorage.initialize
- Defined in msal-browser/src/cache/LocalStorage.ts:79

removeItem

removeItem(key): void
Removes the item in the window storage object matching the given key.
Parameters
- key: string
Returns void
Implementation of IWindowStorage.removeItem
- Defined in msal-browser/src/cache/LocalStorage.ts:215

setItem

setItem(key, value): void
Sets the item in the window storage object with the given key.
Parameters
- key: string
- value: string
Returns void
Implementation of IWindowStorage.setItem
- Defined in msal-browser/src/cache/LocalStorage.ts:176

setUserData

setUserData(key, value, correlationId): Promise<void>
Setter for sensitive data that may contain PII.
Parameters
- key: string
- value: string
- correlationId: string
Returns Promise<void>
Implementation of IWindowStorage.setUserData
- Defined in msal-browser/src/cache/LocalStorage.ts:180

Generated using TypeDoc