feat: add swr alias for staleWhileRevalidate option

Author: Xiphe

readme.md

@@ -122,6 +122,10 @@ interface CachifiedOptions<Value> {
    * Default: `0`
    */
   staleWhileRevalidate?: number;
+  /**
+   * Alias for staleWhileRevalidate
+   */
+  swr?: number;
   /**
    * Validator that checks every cached and fresh value to ensure type safety
    *

src/cachified.spec.ts

@@ -1051,7 +1051,7 @@ describe('cachified', () => {
         cache,
         key: 'test',
         ttl: 5,
-        staleWhileRevalidate: 5,
+        swr: 5,
         getFreshValue,
       });
 

src/common.ts

@@ -115,6 +115,10 @@ export interface CachifiedOptions<Value> {
    * Default: `0`
    */
   staleWhileRevalidate?: number;
+  /**
+   * Alias for staleWhileRevalidate
+   */
+  swr?: number;
   /**
    * Validator that checks every cached and fresh value to ensure type safety
    *
@@ -192,7 +196,7 @@ export type CachifiedOptionsWithSchema<Value, InternalValue> = Omit<
 export interface Context<Value>
   extends Omit<
     Required<CachifiedOptions<Value>>,
-    'fallbackToCache' | 'reporter' | 'checkValue'
+    'fallbackToCache' | 'reporter' | 'checkValue' | 'swr'
   > {
   checkValue: CheckValue<Value>;
   report: Reporter<Value>;
@@ -207,7 +211,7 @@ export function createContext<Value>({
   ...options
 }: CachifiedOptions<Value>): Context<Value> {
   const ttl = options.ttl ?? Infinity;
-  const staleWhileRevalidate = options.staleWhileRevalidate ?? 0;
+  const staleWhileRevalidate = options.swr ?? options.staleWhileRevalidate ?? 0;
   const checkValueCompat: CheckValue<Value> =
     typeof checkValue === 'function'
       ? checkValue