Class TokenCache

In-memory token cache manager

Hierarchy

TokenCache

Implements

Index

Constructors

constructor

Methods

Constructors

constructor

new TokenCache(storage: NodeStorage, logger: Logger, cachePlugin?: ICachePlugin): TokenCache

- Defined in msal-node/src/cache/TokenCache.ts:31
Parameters
- storage: NodeStorage
- logger: Logger
- Optional cachePlugin: ICachePlugin
Returns TokenCache

Methods

deserialize

deserialize(cache: string): void

Implementation of ISerializableTokenCache.deserialize
- Defined in msal-node/src/cache/TokenCache.ts:78
Deserializes JSON to in-memory cache. JSON should be in MSAL cache schema format

Parameters
- cache: string
  
  blob formatted cache
Returns void

getAccountByHomeId

getAccountByHomeId(homeAccountId: string): Promise<AccountInfo>

Implementation of ITokenCache.getAccountByHomeId
- Defined in msal-node/src/cache/TokenCache.ts:126
Returns the signed in account matching homeAccountId. (the account object is created at the time of successful login) or null when no matching account is found

Parameters
- homeAccountId: string
  
  unique identifier for an account (uid.utid)
Returns Promise<AccountInfo>

getAccountByLocalId

getAccountByLocalId(localAccountId: string): Promise<AccountInfo>

Implementation of ITokenCache.getAccountByLocalId
- Defined in msal-node/src/cache/TokenCache.ts:141
Returns the signed in account matching localAccountId. (the account object is created at the time of successful login) or null when no matching account is found

Parameters
- localAccountId: string
  
  unique identifier of an account (sub/obj when homeAccountId cannot be populated)
Returns Promise<AccountInfo>

getAllAccounts

getAllAccounts(): Promise<AccountInfo[]>

Implementation of ITokenCache.getAllAccounts
- Defined in msal-node/src/cache/TokenCache.ts:103
API that retrieves all accounts currently in cache to the user

Returns Promise<AccountInfo[]>

getKVStore

getKVStore(): Record<string, ValidCacheType>

- Defined in msal-node/src/cache/TokenCache.ts:96
Fetches the cache key-value map

Returns Record<string, ValidCacheType>

hasChanged

hasChanged(): boolean

- Defined in msal-node/src/cache/TokenCache.ts:46
Set to true if cache state has changed since last time serialize or writeToPersistence was called

Returns boolean

removeAccount

removeAccount(account: AccountInfo): Promise<void>

Implementation of ITokenCache.removeAccount
- Defined in msal-node/src/cache/TokenCache.ts:154
API to remove a specific account and the relevant data from cache

Parameters
- account: AccountInfo
  
  AccountInfo passed by the user
Returns Promise<void>

serialize

serialize(): string

Implementation of ISerializableTokenCache.serialize
- Defined in msal-node/src/cache/TokenCache.ts:53
Serializes in memory cache to JSON

Returns string

Generated using TypeDoc