@modern-js/types 2.42.2 → 2.43.0

package/package.json

@@ -15,7 +15,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.42.2",
+  "version": "2.43.0",
   "types": "./index.d.ts",
   "exports": {
     ".": {
@@ -45,8 +45,8 @@
     "http-proxy-middleware": "^2.0.4",
     "jest": "^29",
     "type-fest": "2.15.0",
-    "@scripts/build": "2.42.2",
-    "@scripts/jest-config": "2.42.2"
+    "@scripts/build": "2.43.0",
+    "@scripts/jest-config": "2.43.0"
   },
   "sideEffects": false,
   "publishConfig": {

package/server/utils.d.ts

@@ -72,3 +72,61 @@ export type BffProxyOptions =
   | Record<string, ProxyDetail>
   | ProxyDetail[]
   | ProxyDetail;
+
+export type CacheControl = {
+  /**
+   * The maxAge like http cache-control: max-age.
+   *
+   * It refers to the cache validation time, measured in (ms).
+   */
+  maxAge: number;
+
+  /**
+   * The staleWhileRevalidate reference to http header cache-control: stale-while-revalidate.
+   *
+   * It means that the cache is stale but can still be used directly while asynchronously revalidating it, measured in (ms).
+   */
+  staleWhileRevalidate: number;
+
+  /**
+   * Specify a custom cache key yourself.
+   *
+   * The custom key will override the key used by default.
+   */
+  customKey?: string | ((pathname: string) => string);
+};
+
+export type CacheOptionProvider = (
+  req: IncomingMessage,
+) => Promise<CacheControl> | CacheControl;
+
+export type CacheOption =
+  | false
+  | CacheOptionProvider
+  | CacheControl
+  | Record<string, CacheControl | CacheOptionProvider>;
+
+export interface Container<K = string, V = string> {
+  /**
+   * Returns a specified element from the containter. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Containter.
+   * @returns Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
+   */
+  get: (key: K) => Promise<V | undefined>;
+
+  /**
+   * Adds a new element with a specified key and value to the containter. If an element with the same key already exists, the element will be updated.
+   */
+  set: (key: K, value: V, options?: { ttl?: number }) => Promise<this>;
+
+  /**
+   * @returns boolean indicating whether an element with the specified key exists or not.
+   */
+  has: (key: K) => Promise<boolean>;
+
+  /**
+   * @returns true if an element in the containter existed and has been removed, or false if the element does not exist.
+   */
+  delete: (key: K) => Promise<boolean>;
+
+  forEach?: (callbackFn: (v: V, k: K, containter: this) => void) => void;
+}