@node-saml/node-saml/lib/in-memory-cache-provider.d.ts

SAML 2.0 implementation for Node.js

/**
 * Simple in memory cache provider.  To be used to store state of requests that needs
 * to be validated/checked when a response is received.
 *
 * This is the default implementation of a cache provider used by Node SAML.  For
 * multiple server instances/load balanced scenarios (I.e. the SAML request could have
 * been generated from a different server/process handling the SAML response) this
 * implementation will NOT be sufficient.
 *
 * The caller should provide their own implementation for a cache provider as defined
 * in the config options.
 */
import { CacheItem, CacheProvider } from "./types";
interface CacheProviderOptions {
    keyExpirationPeriodMs: number;
}
export declare class InMemoryCacheProvider implements CacheProvider {
    private cacheKeys;
    private options;
    private lastPrune;
    private prune;
    private removeKeyIfExpired;
    constructor(options: Partial<CacheProviderOptions>);
    /**
     * Store an item in the cache, using the specified key and value.
     * Internally will keep track of the time the item was added to the cache
     */
    saveAsync(key: string, value: string): Promise<CacheItem | null>;
    /**
     * Returns the value of the specified key in the cache
     */
    getAsync(key: string): Promise<string | null>;
    /**
     * Removes an item from the cache if it exists
     */
    removeAsync(key: string | null): Promise<string | null>;
}
export {};