UNPKG

@toreda/cache

Version:

Time-based object cache in TypeScript.

43 lines (41 loc) 1.69 kB
/** * MIT License * * Copyright (c) 2019 - 2022 Toreda, Inc. * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE * SOFTWARE. * */ /** * Default values used when no value is provided. */ export declare class Defaults { static CacheItem: { /** Time to Live (seconds). Time before before a cache item expires. */ readonly TTL: 30; }; static Cache: { /** * Hard cap on concurrent cache elements. Used when `capacityMax` is not * provided in cache config. */ readonly CapacityMax: 1000; /** Minimum number of seconds allowed between prune calls. */ readonly PruneDelay: 10; }; }