Method set

cache/ttl_cache.ts:156–196

* Set a value in the cache. * * @experimental **UNSTABLE**: New API, yet to be vetted. * * @param key The cache key. * @param value The value to set. * @param options Options for this entry. * @returns `this` for chaining. * * @example Usage * ```ts * import { TtlCac

(
    key: K,
    value: V,
    options?: TtlCacheSetOptions,
  )

   * ```
   */
  override set(
    key: K,
    value: V,
    options?: TtlCacheSetOptions,
  ): this {
    if (options?.absoluteExpiration !== undefined && !this.#slidingExpiration) {
      throw new TypeError(
        "Cannot set entry in TtlCache: absoluteExpiration requires slidingExpiration to be enabled",
      );
    }

    const ttl = options?.ttl ?? this.#defaultTtl;
    if (!(ttl >= 0) || !Number.isFinite(ttl)) {
      throw new RangeError(
        `Cannot set entry in TtlCache: ttl must be a finite, non-negative number: received ${ttl}`,
      );
    }

    const abs = options?.absoluteExpiration;
    if (abs !== undefined && (!(abs >= 0) || !Number.isFinite(abs))) {
      throw new RangeError(
        `Cannot set entry in TtlCache: absoluteExpiration must be a finite, non-negative number: received ${abs}`,
      );
    }

    const existing = this.#timeouts.get(key);
    if (existing !== undefined) clearTimeout(existing);
    super.set(key, value);
    this.#timeouts.set(key, setTimeout(() => this.delete(key), ttl));

    if (this.#slidingExpiration) {
      this.#entryTtls!.set(key, ttl);
      if (abs !== undefined) {
        this.#absoluteDeadlines!.set(key, Date.now() + abs);
      } else {
        this.#absoluteDeadlines!.delete(key);
      }
    }

    return this;
  }

  /**
   * Gets the value associated with the specified key.