Class NodeStorage

This class implements Storage for node, reading cache from user specified storage location or an extension library

Hierarchy

CacheManager
- NodeStorage

Index

Constructors

Methods

accessTokenKeyMatchesFilter cacheToInMemoryCache clear containsKey credentialMatchesFilter emitChange generateAuthorityMetadataCacheKey getAccessToken getAccessTokenCredential getAccessTokensByFilter getAccount getAccountInfoFilteredBy getAccountKeys getAccountsFilteredBy getAllAccounts getAppMetadata getAppMetadataFilteredBy getAuthorityMetadata getAuthorityMetadataByAlias getAuthorityMetadataKeys getCache getIdToken getIdTokenCredential getIdTokensByFilter getInMemoryCache getItem getKeys getRefreshToken getRefreshTokenCredential getServerTelemetry getThrottlingCache getTokenKeys idTokenKeyMatchesFilter inMemoryCacheToCache isAccountKey isAppMetadataFOCI isCredentialKey readAccountFromCache readAppMetadataFromCache readCacheRecord refreshTokenKeyMatchesFilter registerChangeEmitter removeAccessToken removeAccount removeAccountContext removeAllAccounts removeAppMetadata removeIdToken removeItem removeRefreshToken saveCacheRecord setAccessTokenCredential setAccount setAppMetadata setAuthorityMetadata setCache setIdTokenCredential setInMemoryCache setItem setRefreshTokenCredential setServerTelemetry setThrottlingCache updateCredentialCacheKey generateInMemoryCache generateJsonCache toObject

Constructors

constructor

new NodeStorage(logger, clientId, cryptoImpl): NodeStorage
Parameters
- logger: Logger
- clientId: string
- cryptoImpl: ICrypto
Returns NodeStorage
Overrides CacheManager.constructor
- Defined in msal-node/src/cache/NodeStorage.ts:41

Methods

accessTokenKeyMatchesFilter

accessTokenKeyMatchesFilter(inputKey, filter, keyMustContainAllScopes): boolean
Validate the cache key against filter before retrieving and parsing cache value
Parameters
- inputKey: string
- filter: CredentialFilter
- keyMustContainAllScopes: boolean
Returns boolean
Inherited from CacheManager.accessTokenKeyMatchesFilter
- Defined in msal-common/dist/cache/CacheManager.d.ts:288

cacheToInMemoryCache

cacheToInMemoryCache(cache): InMemoryCache
Converts cacheKVStore to InMemoryCache
Parameters
- cache: CacheKVStore
  
  key value store
Returns InMemoryCache
- Defined in msal-node/src/cache/NodeStorage.ts:65

clear

clear(): Promise<void>
Clears all cache entries created by MSAL (except tokens).

Returns Promise<void>
Overrides CacheManager.clear
- Defined in msal-node/src/cache/NodeStorage.ts:475

containsKey

containsKey(key): boolean
Checks whether key is in cache.
Parameters
- key: string
  
  look up key for a cache entity
Returns boolean
Overrides CacheManager.containsKey
- Defined in msal-node/src/cache/NodeStorage.ts:457

credentialMatchesFilter

credentialMatchesFilter(entity, filter): boolean
Returns whether or not the given credential entity matches the filter
Parameters
- entity: ValidCredentialType
- filter: CredentialFilter
Returns boolean
Inherited from CacheManager.credentialMatchesFilter
- Defined in msal-common/dist/cache/CacheManager.d.ts:189

emitChange

emitChange(): void
Invoke the callback when cache changes

Returns void
- Defined in msal-node/src/cache/NodeStorage.ts:57

generateAuthorityMetadataCacheKey

generateAuthorityMetadataCacheKey(authority): string
returns cache key used for cloud instance metadata
Parameters
- authority: string
Returns string
Inherited from CacheManager.generateAuthorityMetadataCacheKey
- Defined in msal-common/dist/cache/CacheManager.d.ts:412

getAccessToken

getAccessToken(account, request, tokenKeys?): null | AccessTokenEntity
Retrieve AccessTokenEntity from cache
Parameters
- account: AccountInfo
- request: BaseAuthRequest
- Optional tokenKeys: TokenKeys
Returns null | AccessTokenEntity
Inherited from CacheManager.getAccessToken
- Defined in msal-common/dist/cache/CacheManager.d.ts:280

getAccessTokenCredential

getAccessTokenCredential(accessTokenKey): null | AccessTokenEntity
fetch the accessToken credential
Parameters
- accessTokenKey: string
  
  lookup key to fetch cache type AccessTokenEntity
Returns null | AccessTokenEntity
Overrides CacheManager.getAccessTokenCredential
- Defined in msal-node/src/cache/NodeStorage.ts:257

getAccessTokensByFilter

getAccessTokensByFilter(filter): AccessTokenEntity[]
Gets all access tokens matching the filter
Parameters
- filter: CredentialFilter
Returns AccessTokenEntity[]
Inherited from CacheManager.getAccessTokensByFilter
- Defined in msal-common/dist/cache/CacheManager.d.ts:294

getAccount

getAccount(accountKey): null | AccountEntity
fetch the account entity
Parameters
- accountKey: string
  
  lookup key to fetch cache type AccountEntity
Returns null | AccountEntity
Overrides CacheManager.getAccount
- Defined in msal-node/src/cache/NodeStorage.ts:215

getAccountInfoFilteredBy

getAccountInfoFilteredBy(accountFilter): null | AccountInfo
Gets accountInfo object based on provided filters
Parameters
- accountFilter: AccountFilter
Returns null | AccountInfo
Inherited from CacheManager.getAccountInfoFilteredBy
- Defined in msal-common/dist/cache/CacheManager.d.ts:150

getAccountKeys

getAccountKeys(): string[]
Returns string[]
Overrides CacheManager.getAccountKeys
- Defined in msal-node/src/cache/NodeStorage.ts:193

getAccountsFilteredBy

getAccountsFilteredBy(accountFilter): AccountEntity[]
retrieve accounts matching all provided filters; if no filter is set, get all accounts not checking for casing as keys are all generated in lower case, remember to convert to lower case if object properties are compared
Parameters
- accountFilter: AccountFilter
Returns AccountEntity[]
Inherited from CacheManager.getAccountsFilteredBy
- Defined in msal-common/dist/cache/CacheManager.d.ts:169

getAllAccounts

getAllAccounts(): AccountInfo[]
Returns all accounts in cache

Returns AccountInfo[]
Inherited from CacheManager.getAllAccounts
- Defined in msal-common/dist/cache/CacheManager.d.ts:146

getAppMetadata

getAppMetadata(appMetadataKey): null | AppMetadataEntity
fetch appMetadata entity from the platform cache
Parameters
- appMetadataKey: string
  
  lookup key to fetch cache type AppMetadataEntity
Returns null | AppMetadataEntity
Overrides CacheManager.getAppMetadata
- Defined in msal-node/src/cache/NodeStorage.ts:303

getAppMetadataFilteredBy

getAppMetadataFilteredBy(filter): AppMetadataCache
retrieve appMetadata matching all provided filters; if no filter is set, get all appMetadata
Parameters
- filter: AppMetadataFilter
Returns AppMetadataCache
Inherited from CacheManager.getAppMetadataFilteredBy
- Defined in msal-common/dist/cache/CacheManager.d.ts:194

getAuthorityMetadata

getAuthorityMetadata(key): null | AuthorityMetadataEntity
fetch authority metadata entity from the platform cache
Parameters
- key: string
  
  lookup key to fetch cache type AuthorityMetadataEntity
Returns null | AuthorityMetadataEntity
Overrides CacheManager.getAuthorityMetadata
- Defined in msal-node/src/cache/NodeStorage.ts:362

getAuthorityMetadataByAlias

getAuthorityMetadataByAlias(host): null | AuthorityMetadataEntity
retrieve authorityMetadata that contains a matching alias
Parameters
- host: string
Returns null | AuthorityMetadataEntity
Inherited from CacheManager.getAuthorityMetadataByAlias
- Defined in msal-common/dist/cache/CacheManager.d.ts:205

getAuthorityMetadataKeys

getAuthorityMetadataKeys(): string[]
Get all authority metadata keys

Returns string[]
Overrides CacheManager.getAuthorityMetadataKeys
- Defined in msal-node/src/cache/NodeStorage.ts:381

getCache

getCache(): CacheKVStore
get the current cache key-value store

Returns CacheKVStore
- Defined in msal-node/src/cache/NodeStorage.ts:148

getIdToken

getIdToken(account, tokenKeys?): null | IdTokenEntity
Retrieve IdTokenEntity from cache
Parameters
- account: AccountInfo
- Optional tokenKeys: TokenKeys
Returns null | IdTokenEntity
Inherited from CacheManager.getIdToken
- Defined in msal-common/dist/cache/CacheManager.d.ts:249

getIdTokenCredential

getIdTokenCredential(idTokenKey): null | IdTokenEntity
fetch the idToken credential
Parameters
- idTokenKey: string
  
  lookup key to fetch cache type IdTokenEntity
Returns null | IdTokenEntity
Overrides CacheManager.getIdTokenCredential
- Defined in msal-node/src/cache/NodeStorage.ts:236

getIdTokensByFilter

getIdTokensByFilter(filter, tokenKeys?): IdTokenEntity[]
Gets all idTokens matching the given filter
Parameters
- filter: CredentialFilter
- Optional tokenKeys: TokenKeys
Returns IdTokenEntity[]
Inherited from CacheManager.getIdTokensByFilter
- Defined in msal-common/dist/cache/CacheManager.d.ts:255

getInMemoryCache

getInMemoryCache(): InMemoryCache
gets the current in memory cache for the client

Returns InMemoryCache
- Defined in msal-node/src/cache/NodeStorage.ts:123

getItem

getItem(key): ValidCacheType
Gets cache item with given key.
Parameters
- key: string
  
  lookup key for the cache entry
Returns ValidCacheType
- Defined in msal-node/src/cache/NodeStorage.ts:169

getKeys

getKeys(): string[]
Gets all keys in window.

Returns string[]
Overrides CacheManager.getKeys
- Defined in msal-node/src/cache/NodeStorage.ts:464

getRefreshToken

getRefreshToken(account, familyRT, tokenKeys?): null | RefreshTokenEntity
Helper to retrieve the appropriate refresh token from cache
Parameters
- account: AccountInfo
- familyRT: boolean
- Optional tokenKeys: TokenKeys
Returns null | RefreshTokenEntity
Inherited from CacheManager.getRefreshToken
- Defined in msal-common/dist/cache/CacheManager.d.ts:301

getRefreshTokenCredential

getRefreshTokenCredential(refreshTokenKey): null | RefreshTokenEntity
fetch the refreshToken credential
Parameters
- refreshTokenKey: string
  
  lookup key to fetch cache type RefreshTokenEntity
Returns null | RefreshTokenEntity
Overrides CacheManager.getRefreshTokenCredential
- Defined in msal-node/src/cache/NodeStorage.ts:278

getServerTelemetry

getServerTelemetry(serverTelemetrykey): null | ServerTelemetryEntity
fetch server telemetry entity from the platform cache
Parameters
- serverTelemetrykey: string
  
  lookup key to fetch cache type ServerTelemetryEntity
Returns null | ServerTelemetryEntity
Overrides CacheManager.getServerTelemetry
- Defined in msal-node/src/cache/NodeStorage.ts:328

getThrottlingCache

getThrottlingCache(throttlingCacheKey): null | ThrottlingEntity
fetch throttling entity from the platform cache
Parameters
- throttlingCacheKey: string
  
  lookup key to fetch cache type ThrottlingEntity
Returns null | ThrottlingEntity
Overrides CacheManager.getThrottlingCache
- Defined in msal-node/src/cache/NodeStorage.ts:400

getTokenKeys

getTokenKeys(): TokenKeys
Returns TokenKeys
Overrides CacheManager.getTokenKeys
- Defined in msal-node/src/cache/NodeStorage.ts:200

idTokenKeyMatchesFilter

idTokenKeyMatchesFilter(inputKey, filter): boolean
Validate the cache key against filter before retrieving and parsing cache value
Parameters
- inputKey: string
- filter: CredentialFilter
Returns boolean
Inherited from CacheManager.idTokenKeyMatchesFilter
- Defined in msal-common/dist/cache/CacheManager.d.ts:262

inMemoryCacheToCache

inMemoryCacheToCache(inMemoryCache): CacheKVStore
converts inMemoryCache to CacheKVStore
Parameters
- inMemoryCache: InMemoryCache
  
  kvstore map for inmemory
Returns CacheKVStore
- Defined in msal-node/src/cache/NodeStorage.ts:103

isAccountKey

isAccountKey(key, homeAccountId?, tenantId?): boolean
Returns true if the given key matches our account key schema. Also matches homeAccountId and/or tenantId if provided
Parameters
- key: string
- Optional homeAccountId: string
- Optional tenantId: string
Returns boolean
Inherited from CacheManager.isAccountKey
- Defined in msal-common/dist/cache/CacheManager.d.ts:177

isAppMetadataFOCI

isAppMetadataFOCI(environment): boolean
Return the family_id value associated with FOCI
Parameters
- environment: string
Returns boolean
Inherited from CacheManager.isAppMetadataFOCI
- Defined in msal-common/dist/cache/CacheManager.d.ts:317

isCredentialKey

isCredentialKey(key): boolean
Returns true if the given key matches our credential key schema.
Parameters
- key: string
Returns boolean
Inherited from CacheManager.isCredentialKey
- Defined in msal-common/dist/cache/CacheManager.d.ts:182

readAccountFromCache

readAccountFromCache(account): null | AccountEntity
Retrieve AccountEntity from cache
Parameters
- account: AccountInfo
Returns null | AccountEntity
Inherited from CacheManager.readAccountFromCache
- Defined in msal-common/dist/cache/CacheManager.d.ts:242

readAppMetadataFromCache

readAppMetadataFromCache(environment): null | AppMetadataEntity
Retrieve AppMetadataEntity from cache
Parameters
- environment: string
Returns null | AppMetadataEntity
Inherited from CacheManager.readAppMetadataFromCache
- Defined in msal-common/dist/cache/CacheManager.d.ts:311

readCacheRecord

readCacheRecord(account, request, environment): CacheRecord
Retrieve the cached credentials into a cacherecord
Parameters
- account: AccountInfo
- request: BaseAuthRequest
- environment: string
Returns CacheRecord
Inherited from CacheManager.readCacheRecord
- Defined in msal-common/dist/cache/CacheManager.d.ts:237

refreshTokenKeyMatchesFilter

refreshTokenKeyMatchesFilter(inputKey, filter): boolean
Validate the cache key against filter before retrieving and parsing cache value
Parameters
- inputKey: string
- filter: CredentialFilter
Returns boolean
Inherited from CacheManager.refreshTokenKeyMatchesFilter
- Defined in msal-common/dist/cache/CacheManager.d.ts:307

registerChangeEmitter

registerChangeEmitter(func): void
Queue up callbacks
Parameters
- func: (() => void)
  
  a callback function for cache change indication
  - - (): void
    - Returns void
Returns void
- Defined in msal-node/src/cache/NodeStorage.ts:50

removeAccessToken

removeAccessToken(key): Promise<void>
returns a boolean if the given credential is removed
Parameters
- key: string
Returns Promise<void>
Inherited from CacheManager.removeAccessToken
- Defined in msal-common/dist/cache/CacheManager.d.ts:224

removeAccount

removeAccount(accountKey): Promise<void>
Removes the account and related tokens for a given account key
Parameters
- accountKey: string
Returns Promise<void>
Inherited from CacheManager.removeAccount
- Defined in msal-common/dist/cache/CacheManager.d.ts:214

removeAccountContext

removeAccountContext(account): Promise<void>
Removes credentials associated with the provided account
Parameters
- account: AccountEntity
Returns Promise<void>
Inherited from CacheManager.removeAccountContext
- Defined in msal-common/dist/cache/CacheManager.d.ts:219

removeAllAccounts

removeAllAccounts(): Promise<void>
Removes all accounts and related tokens from cache.

Returns Promise<void>
Inherited from CacheManager.removeAllAccounts
- Defined in msal-common/dist/cache/CacheManager.d.ts:209

removeAppMetadata

removeAppMetadata(): boolean
Removes all app metadata objects from cache.

Returns boolean
Inherited from CacheManager.removeAppMetadata
- Defined in msal-common/dist/cache/CacheManager.d.ts:228

removeIdToken

removeIdToken(key): void
Removes idToken from the cache
Parameters
- key: string
Returns void
Inherited from CacheManager.removeIdToken
- Defined in msal-common/dist/cache/CacheManager.d.ts:267

removeItem

removeItem(key): boolean
Removes the cache item from memory with the given key.
Parameters
- key: string
  
  lookup key to remove a cache entity
Returns boolean
Overrides CacheManager.removeItem
- Defined in msal-node/src/cache/NodeStorage.ts:433

removeRefreshToken

removeRefreshToken(key): void
Removes refresh token from the cache
Parameters
- key: string
Returns void
Inherited from CacheManager.removeRefreshToken
- Defined in msal-common/dist/cache/CacheManager.d.ts:272

saveCacheRecord

saveCacheRecord(cacheRecord, storeInCache?): Promise<void>
saves a cache record
Parameters
- cacheRecord: CacheRecord
- Optional storeInCache: StoreInCache
Returns Promise<void>
Inherited from CacheManager.saveCacheRecord
- Defined in msal-common/dist/cache/CacheManager.d.ts:156

setAccessTokenCredential

setAccessTokenCredential(accessToken): void
set accessToken credential
Parameters
- accessToken: AccessTokenEntity
  
  cache value to be set of type AccessTokenEntity
Returns void
Overrides CacheManager.setAccessTokenCredential
- Defined in msal-node/src/cache/NodeStorage.ts:269

setAccount

setAccount(account): void
set account entity
Parameters
- account: AccountEntity
  
  cache value to be set of type AccountEntity
Returns void
Overrides CacheManager.setAccount
- Defined in msal-node/src/cache/NodeStorage.ts:227

setAppMetadata

setAppMetadata(appMetadata): void
set appMetadata entity to the platform cache
Parameters
- appMetadata: AppMetadataEntity
  
  cache value to be set of type AppMetadataEntity
Returns void
Overrides CacheManager.setAppMetadata
- Defined in msal-node/src/cache/NodeStorage.ts:319

setAuthorityMetadata

setAuthorityMetadata(key, metadata): void
set authority metadata entity to the platform cache
Parameters
- key: string
  
  lookup key to fetch cache type AuthorityMetadataEntity
- metadata: AuthorityMetadataEntity
  
  cache value to be set of type AuthorityMetadataEntity
Returns void
Overrides CacheManager.setAuthorityMetadata
- Defined in msal-node/src/cache/NodeStorage.ts:392

setCache

setCache(cache): void
sets the current cache (key value store)
Parameters
- cache: CacheKVStore
Returns void
- Defined in msal-node/src/cache/NodeStorage.ts:157

setIdTokenCredential

setIdTokenCredential(idToken): void
set idToken credential
Parameters
- idToken: IdTokenEntity
  
  cache value to be set of type IdTokenEntity
Returns void
Overrides CacheManager.setIdTokenCredential
- Defined in msal-node/src/cache/NodeStorage.ts:248

setInMemoryCache

setInMemoryCache(inMemoryCache): void
sets the current in memory cache for the client
Parameters
- inMemoryCache: InMemoryCache
  
  key value map in memory
Returns void
- Defined in msal-node/src/cache/NodeStorage.ts:135

setItem

setItem(key, value): void
Gets cache item with given key-value
Parameters
- key: string
  
  lookup key for the cache entry
- value: ValidCacheType
  
  value of the cache entry
Returns void
- Defined in msal-node/src/cache/NodeStorage.ts:182

setRefreshTokenCredential

setRefreshTokenCredential(refreshToken): void
set refreshToken credential
Parameters
- refreshToken: RefreshTokenEntity
  
  cache value to be set of type RefreshTokenEntity
Returns void
Overrides CacheManager.setRefreshTokenCredential
- Defined in msal-node/src/cache/NodeStorage.ts:294

setServerTelemetry

setServerTelemetry(serverTelemetryKey, serverTelemetry): void
set server telemetry entity to the platform cache
Parameters
- serverTelemetryKey: string
  
  lookup key to fetch cache type ServerTelemetryEntity
- serverTelemetry: ServerTelemetryEntity
  
  cache value to be set of type ServerTelemetryEntity
Returns void
Overrides CacheManager.setServerTelemetry
- Defined in msal-node/src/cache/NodeStorage.ts:351

setThrottlingCache

setThrottlingCache(throttlingCacheKey, throttlingCache): void
set throttling entity to the platform cache
Parameters
- throttlingCacheKey: string
  
  lookup key to fetch cache type ThrottlingEntity
- throttlingCache: ThrottlingEntity
  
  cache value to be set of type ThrottlingEntity
Returns void
Overrides CacheManager.setThrottlingCache
- Defined in msal-node/src/cache/NodeStorage.ts:421

updateCredentialCacheKey

updateCredentialCacheKey(currentCacheKey, credential): string
Updates a credential's cache key if the current cache key is outdated
Parameters
- currentCacheKey: string
- credential: ValidCredentialType
Returns string
Overrides CacheManager.updateCredentialCacheKey
- Defined in msal-node/src/cache/NodeStorage.ts:509

`Static` generateInMemoryCache

generateInMemoryCache(cache): InMemoryCache
Initialize in memory cache from an exisiting cache vault
Parameters
- cache: string
  
  blob formatted cache (JSON)
Returns InMemoryCache
- Defined in msal-node/src/cache/NodeStorage.ts:492

`Static` generateJsonCache

generateJsonCache(inMemoryCache): JsonCache
retrieves the final JSON
Parameters
- inMemoryCache: InMemoryCache
  
  itemised cache read from the JSON
Returns JsonCache
- Defined in msal-node/src/cache/NodeStorage.ts:502

`Static` toObject

toObject<T>(obj, json): T
Helper to convert serialized data to object
Type Parameters
- T
Parameters
- obj: T
- json: object
Returns T
Inherited from CacheManager.toObject
- Defined in msal-common/dist/cache/CacheManager.d.ts:418

Generated using TypeDoc