Skip to content

Sync-in · Sovereign platform for file storage, sharing, synchronization, and collaboration.

1.3 KB
Raw Blame
import { OnModuleDestroy, OnModuleInit } from '@nestjs/common'
import type { CacheRateLimitResult } from './interfaces/cache-rate-limit.interface.js'

export abstract class Cache implements OnModuleInit, OnModuleDestroy {
  abstract defaultTTL: number
  abstract infiniteExpiration: number

  abstract onModuleInit(): void

  abstract onModuleDestroy(): void

  abstract has(key: string): Promise<boolean>

  /*
    pattern supports only '*' as wildcard
   */
  abstract keys(pattern: string): Promise<string[]>

  abstract get(key: string): Promise<any>

  /*
    values preserve the requested key order; missing keys return undefined
   */
  abstract mget(keys: string[]): Promise<any[]>

  abstract increment(key: string, amount?: number, ttl?: number, minimum?: number): Promise<number>

  // Atomically consumes a request; ttl and blockDuration are in milliseconds.
  abstract consumeRateLimit(key: string, ttl: number, limit: number, blockDuration: number): Promise<CacheRateLimitResult>

  /* ttl (seconds):
      - 0: infinite expiration
      - undefined: default ttl
  */
  abstract set(key: string, data: unknown, ttl?: number): Promise<boolean>

  abstract del(key: string): Promise<boolean>

  /*
    returns true when at least one key was deleted
   */
  abstract mdel(keys: string[]): Promise<boolean>

  abstract genSlugKey(...args: any[]): string
}