NodeStorage class

new NodeStorage(logger: Logger, clientId: string, cryptoImpl: ICrypto)

Parameters

Converts cacheKVStore to InMemoryCache

function cacheToInMemoryCache(cache: CacheKVStore): InMemoryCache

Parameters

Returns

Clears all cache entries created by MSAL (except tokens).

function clear(): Promise<void>

Returns

Checks whether key is in cache.

function containsKey(key: string): boolean

Parameters

Returns

Invoke the callback when cache changes

function emitChange()

Initialize in memory cache from an exisiting cache vault

static function generateInMemoryCache(cache: string): InMemoryCache

Parameters

Returns

retrieves the final JSON

static function generateJsonCache(inMemoryCache: InMemoryCache): JsonCache

Parameters

Returns

fetch the accessToken credential

function getAccessTokenCredential(accessTokenKey: string): AccessTokenEntity | null

Parameters

Returns

fetch the account entity

function getAccount(accountKey: string): AccountEntity | null

Parameters

Returns

fetch appMetadata entity from the platform cache

function getAppMetadata(appMetadataKey: string): AppMetadataEntity | null

Parameters

Returns

fetch authority metadata entity from the platform cache

function getAuthorityMetadata(key: string): AuthorityMetadataEntity | null

Parameters

Returns

Get all authority metadata keys

function getAuthorityMetadataKeys(): Array<string>

Returns

get the current cache key-value store

function getCache(): CacheKVStore

Returns

fetch the idToken credential

function getIdTokenCredential(idTokenKey: string): IdTokenEntity | null

Parameters

Returns

gets the current in memory cache for the client

function getInMemoryCache(): InMemoryCache

Returns

Gets cache item with given key.

function getItem(key: string): ValidCacheType

Parameters

Returns

Gets all keys in window.

function getKeys(): string[]

Returns

fetch the refreshToken credential

function getRefreshTokenCredential(refreshTokenKey: string): RefreshTokenEntity | null

Parameters

Returns

fetch server telemetry entity from the platform cache

function getServerTelemetry(serverTelemetrykey: string): ServerTelemetryEntity | null

Parameters

Returns

fetch throttling entity from the platform cache

function getThrottlingCache(throttlingCacheKey: string): ThrottlingEntity | null

Parameters

Returns

converts inMemoryCache to CacheKVStore

function inMemoryCacheToCache(inMemoryCache: InMemoryCache): CacheKVStore

Parameters

Returns

Queue up callbacks

function registerChangeEmitter(func: () => void)

Parameters

Removes the cache item from memory with the given key.

function removeItem(key: string): boolean

Parameters

Returns

set accessToken credential

function setAccessTokenCredential(accessToken: AccessTokenEntity)

Parameters

set account entity

function setAccount(account: AccountEntity)

Parameters

set appMetadata entity to the platform cache

function setAppMetadata(appMetadata: AppMetadataEntity)

Parameters

set authority metadata entity to the platform cache

function setAuthorityMetadata(key: string, metadata: AuthorityMetadataEntity)

Parameters

sets the current cache (key value store)

function setCache(cache: CacheKVStore)

Parameters

set idToken credential

function setIdTokenCredential(idToken: IdTokenEntity)

Parameters

sets the current in memory cache for the client

function setInMemoryCache(inMemoryCache: InMemoryCache)

Parameters

Gets cache item with given key-value

function setItem(key: string, value: ValidCacheType)

Parameters

set refreshToken credential

function setRefreshTokenCredential(refreshToken: RefreshTokenEntity)

Parameters

set server telemetry entity to the platform cache

function setServerTelemetry(serverTelemetryKey: string, serverTelemetry: ServerTelemetryEntity)

Parameters

set throttling entity to the platform cache

function setThrottlingCache(throttlingCacheKey: string, throttlingCache: ThrottlingEntity)

Parameters

Updates a credential's cache key if the current cache key is outdated

function updateCredentialCacheKey(currentCacheKey: string, credential: ValidCredentialType): string

Parameters

Returns

returns cache key used for cloud instance metadata

function generateAuthorityMetadataCacheKey(authority: string): string

Parameters

Returns

Inherited From CacheManager.generateAuthorityMetadataCacheKey

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

function getAccountsFilteredBy(accountFilter?: AccountFilter): AccountCache

Parameters

Returns

Inherited From CacheManager.getAccountsFilteredBy

Returns all accounts in cache

function getAllAccounts(): AccountInfo[]

Returns

Inherited From CacheManager.getAllAccounts

retrieve appMetadata matching all provided filters; if no filter is set, get all appMetadata

function getAppMetadataFilteredBy(filter: AppMetadataFilter): AppMetadataCache

Parameters

Returns

Inherited From CacheManager.getAppMetadataFilteredBy

retrieve authorityMetadata that contains a matching alias

function getAuthorityMetadataByAlias(host: string): AuthorityMetadataEntity | null

Parameters

Returns

Inherited From CacheManager.getAuthorityMetadataByAlias

retrieve credentails matching all provided filters; if no filter is set, get all credentials

function getCredentialsFilteredBy(filter: CredentialFilter): CredentialCache

Parameters

Returns

Inherited From CacheManager.getCredentialsFilteredBy

Return the family_id value associated with FOCI

function isAppMetadataFOCI(environment: string, clientId: string): boolean

Parameters

Returns

Inherited From CacheManager.isAppMetadataFOCI

Retrieve AccessTokenEntity from cache

function readAccessTokenFromCache(clientId: string, account: AccountInfo, request: BaseAuthRequest): AccessTokenEntity | null

Parameters

Returns

Inherited From CacheManager.readAccessTokenFromCache

Retrieve AccountEntity from cache

function readAccountFromCache(account: AccountInfo): AccountEntity | null

Parameters

Returns

Inherited From CacheManager.readAccountFromCache

Retrieve AccountEntity from cache

function readAccountFromCacheWithNativeAccountId(nativeAccountId: string): AccountEntity | null

Parameters

Returns

AccountEntity or Null

Inherited From CacheManager.readAccountFromCacheWithNativeAccountId

Retrieve AppMetadataEntity from cache

function readAppMetadataFromCache(environment: string, clientId: string): AppMetadataEntity | null

Parameters

Returns

Inherited From CacheManager.readAppMetadataFromCache

Retrieve the cached credentials into a cacherecord

function readCacheRecord(account: AccountInfo, clientId: string, request: BaseAuthRequest, environment: string): CacheRecord

Parameters

Returns

Inherited From CacheManager.readCacheRecord

Retrieve IdTokenEntity from cache

function readIdTokenFromCache(clientId: string, account: AccountInfo): IdTokenEntity | null

Parameters

Returns

Inherited From CacheManager.readIdTokenFromCache

Helper to retrieve the appropriate refresh token from cache

function readRefreshTokenFromCache(clientId: string, account: AccountInfo, familyRT: boolean): RefreshTokenEntity | null

Parameters

Returns

Inherited From CacheManager.readRefreshTokenFromCache

returns a boolean if the given account is removed

function removeAccount(accountKey: string): Promise<boolean>

Parameters

Returns

Inherited From CacheManager.removeAccount

Removes credentials associated with the provided account

function removeAccountContext(account: AccountEntity): Promise<boolean>

Parameters

Returns

Inherited From CacheManager.removeAccountContext

Removes all accounts and related tokens from cache.

function removeAllAccounts(): Promise<boolean>

Returns

Inherited From CacheManager.removeAllAccounts

Removes all app metadata objects from cache.

function removeAppMetadata(): boolean

Returns

Inherited From CacheManager.removeAppMetadata

returns a boolean if the given credential is removed

function removeCredential(credential: CredentialEntity): Promise<boolean>

Parameters

Returns

Inherited From CacheManager.removeCredential

saves a cache record

function saveCacheRecord(cacheRecord: CacheRecord): Promise<void>

Parameters

Returns

Inherited From CacheManager.saveCacheRecord

Helper to convert serialized data to object

static function toObject<T>(obj: T, json: object): T

Parameters

Returns

Inherited From CacheManager.toObject