Class TokenCache

In-memory token cache manager

Hierarchy

TokenCache

Implements

Index

Constructors

constructor

Methods

deserialize getAccountByHomeId getAccountByLocalId getAllAccounts getKVStore hasChanged removeAccount serialize

Constructors

constructor

new TokenCache(storage, logger, cachePlugin?): TokenCache
Parameters
- storage: NodeStorage
- logger: Logger
- Optional cachePlugin: ICachePlugin
Returns TokenCache
- Defined in msal-node/src/cache/TokenCache.ts:48

Methods

deserialize

deserialize(cache): void
Deserializes JSON to in-memory cache. JSON should be in MSAL cache schema format
Parameters
- cache: string
  
  blob formatted cache
Returns void
Implementation of ISerializableTokenCache.deserialize
- Defined in msal-node/src/cache/TokenCache.ts:97

getAccountByHomeId

getAccountByHomeId(homeAccountId): Promise<null | AccountInfo>
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<null | AccountInfo>
Implementation of ITokenCache.getAccountByHomeId
- Defined in msal-node/src/cache/TokenCache.ts:144

getAccountByLocalId

getAccountByLocalId(localAccountId): Promise<null | AccountInfo>
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<null | AccountInfo>
Implementation of ITokenCache.getAccountByLocalId
- Defined in msal-node/src/cache/TokenCache.ts:165

getAllAccounts

getAllAccounts(): Promise<AccountInfo[]>
API that retrieves all accounts currently in cache to the user

Returns Promise<AccountInfo[]>
Implementation of ITokenCache.getAllAccounts
- Defined in msal-node/src/cache/TokenCache.ts:122

getKVStore

getKVStore(): CacheKVStore
Fetches the cache key-value map

Returns CacheKVStore
- Defined in msal-node/src/cache/TokenCache.ts:115

hasChanged

hasChanged(): boolean
Set to true if cache state has changed since last time serialize or writeToPersistence was called

Returns boolean
- Defined in msal-node/src/cache/TokenCache.ts:65

removeAccount

removeAccount(account): Promise<void>
API to remove a specific account and the relevant data from cache
Parameters
- account: AccountInfo
  
  AccountInfo passed by the user
Returns Promise<void>
Implementation of ITokenCache.removeAccount
- Defined in msal-node/src/cache/TokenCache.ts:184

serialize

serialize(): string
Serializes in memory cache to JSON

Returns string
Implementation of ISerializableTokenCache.serialize
- Defined in msal-node/src/cache/TokenCache.ts:72

Class TokenCache

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

storage: NodeStorage

logger: Logger

Optional cachePlugin: ICachePlugin

Returns TokenCache

Methods

deserialize

Parameters

cache: string

Returns void

getAccountByHomeId

Parameters

homeAccountId: string

Returns Promise<null | AccountInfo>

getAccountByLocalId

Parameters

localAccountId: string

Returns Promise<null | AccountInfo>

getAllAccounts

Returns Promise<AccountInfo[]>

getKVStore

Returns CacheKVStore

hasChanged

Returns boolean

removeAccount

Parameters

account: AccountInfo

Returns Promise<void>

serialize

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` cachePlugin: ICachePlugin