🤖 Merge PR DefinitelyTyped#66625 feat: Add types for route-cache by @yutak23

* feat: Add types for route-cache

* fix: change 'typeof import' to RouteCache

* fix: no export class

Author: yutak23

types/route-cache/index.d.ts

@@ -0,0 +1,34 @@
+// Type definitions for route-cache 0.5
+// Project: https://github.com/bradoyler/route-cache
+// Definitions by: yutak23 <https://github.com/yutak23>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+import * as express from 'express';
+
+export function config(options: ConfigOptions): RouteCache;
+export function cacheSeconds(secondsTTL: number, cacheKey: string | CacheKeyFunc): express.RequestHandler;
+export function removeCache(url: string): void;
+
+export const cacheStore: Store;
+
+export interface RouteCache {
+    config(options: ConfigOptions): RouteCache;
+    cacheSeconds(secondsTTL: number, cacheKey: string | CacheKeyFunc): express.RequestHandler;
+    removeCache(url: string): void;
+    cacheStore: Store;
+}
+
+export interface CacheKeyFunc {
+    (req: express.Request, res: express.Response): string | null;
+}
+
+export interface ConfigOptions {
+    max?: number;
+    cacheStore?: Store;
+}
+
+export interface Store {
+    get(key: string): Promise<any>;
+    set(key: string, value: any, ttlMillis: number): Promise<'OK'> | Promise<boolean>;
+    del(key: string): Promise<number> | Promise<void>;
+}

types/route-cache/ioRedisStore.d.ts

@@ -0,0 +1,14 @@
+import { Redis } from 'ioredis';
+import { Store } from './index';
+
+export = IoRedisStore;
+
+declare class IoRedisStore implements Store {
+    client: Redis;
+
+    constructor(redisClient: Redis);
+
+    get(key: string): Promise<any>;
+    set(key: string, value: any, ttlMillis: number): Promise<'OK'>;
+    del(key: string): Promise<number>;
+}

types/route-cache/lruStore.d.ts

@@ -0,0 +1,20 @@
+import * as LRUCache from 'lru-cache';
+import { Store } from './index';
+
+export = LruStore;
+
+declare class LruStore implements Store {
+    lru: LRUCache;
+
+    constructor(defaults: DefaultOptions<string, any>);
+
+    get(key: string): Promise<any>;
+    set(key: string, value: any, ttlMillis: number): Promise<boolean>;
+    del(key: string): Promise<void>;
+}
+
+interface DefaultOptions<K, V> {
+    max?: number;
+    length?: (value: V, key: K) => number;
+    maxAge?: number;
+}

types/route-cache/package.json

@@ -0,0 +1,7 @@
+{
+    "private": true,
+    "dependencies": {
+        "ioredis": "^5.3.2",
+        "@types/lru-cache": "^4.1.3"
+    }
+}

types/route-cache/route-cache-tests.ts

@@ -0,0 +1,36 @@
+import routeCache = require('route-cache');
+import IoRedisStore = require('route-cache/ioRedisStore');
+import LruStore = require('route-cache/lruStore');
+import * as express from 'express';
+import Redis from 'ioredis';
+
+const redis = new Redis();
+const ioRedisStore: IoRedisStore = new IoRedisStore(redis);
+const lruStore: LruStore = new LruStore({ max: 100, length: (value: any, key: string) => 1, maxAge: 1000 });
+
+const configRedisStore: routeCache.ConfigOptions = { max: 100, cacheStore: ioRedisStore };
+const configLruStore: routeCache.ConfigOptions = { max: 100, cacheStore: lruStore };
+
+const cacheKeyFunc: routeCache.CacheKeyFunc = (req: express.Request, res: express.Response) => 'foo';
+const cacheKeyFuncNull: routeCache.CacheKeyFunc = (req: express.Request, res: express.Response) => null;
+
+routeCache.config({ max: 100, cacheStore: ioRedisStore }); // $ExpectType RouteCache
+routeCache.config({ max: 100, cacheStore: lruStore }); // $ExpectType RouteCache
+routeCache.config({ max: 10 }).config({ max: 100 }); // $ExpectType RouteCache
+
+routeCache.config(configRedisStore); // $ExpectType RouteCache
+routeCache.config(configLruStore); // $ExpectType RouteCache
+
+routeCache.config({ max: 100 }).cacheSeconds(10, 'foo'); // $ExpectType RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
+routeCache.cacheSeconds(10, cacheKeyFunc); // $ExpectType RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
+routeCache.cacheSeconds(10, cacheKeyFuncNull); // $ExpectType RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
+routeCache.cacheSeconds(10, 'foo'); // $ExpectType RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
+
+routeCache.removeCache('foo'); // $ExpectType void
+routeCache.config({ max: 100 }).removeCache('foo'); // $ExpectType void
+
+routeCache.cacheStore; // $ExpectType Store
+routeCache.config({ max: 100 }).cacheStore; // $ExpectType Store
+
+const app = express();
+app.use(routeCache.config({ max: 100 }).cacheSeconds(10, 'foo')); // $ExpectType Express

types/route-cache/tsconfig.json

@@ -0,0 +1,23 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "baseUrl": "../",
+        "typeRoots": [
+            "../"
+        ],
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "route-cache-tests.ts"
+    ]
+}

types/route-cache/tslint.json

@@ -0,0 +1 @@
+{ "extends": "@definitelytyped/dtslint/dt.json" }