Merge pull request #31615 from BendingBender/quick-lru

[quick-lru] Update types to v2

types/got/got-tests.ts

@@ -253,7 +253,7 @@ got('todomvc', {
 }).then(res => res.fromCache);
 
 got('todomvc', {
-    cache: new QuickLRU(),
+    cache: new QuickLRU({maxSize: 10}),
 }).then(res => res.fromCache);
 
 got(new url.URL('http://todomvc.com'));

types/got/v8/got-tests.ts

@@ -252,7 +252,7 @@ got('todomvc', {
 }).then(res => res.fromCache);
 
 got('todomvc', {
-    cache: new QuickLRU(),
+    cache: new QuickLRU({maxSize: 10}),
 }).then(res => res.fromCache);
 
 got(new url.URL('http://todomvc.com'));

types/quick-lru/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for quick-lru 1.1
+// Type definitions for quick-lru 2.0
 // Project: https://github.com/sindresorhus/quick-lru#readme
 // Definitions by: BendingBender <https://github.com/BendingBender>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,13 +7,13 @@ export = QuickLRU;
 
 declare class QuickLRU<K, V> implements Iterable<[K, V]> {
     readonly size: number;
-    constructor(options?: QuickLRU.Options);
+    constructor(options: QuickLRU.Options);
     [Symbol.iterator](): Iterator<[K, V]>;
     set(key: K, value: V): this;
     get(key: K): V | undefined;
     has(key: K): boolean;
     peek(key: K): V | undefined;
-    delete(key: K): void;
+    delete(key: K): boolean;
     clear(): void;
     keys(): Iterable<K>;
     values(): Iterable<V>;

types/quick-lru/quick-lru-tests.ts

@@ -1,29 +1,25 @@
 import QuickLRU = require('quick-lru');
 
-let num: number;
-let numu: number | undefined;
-let str: string;
-let bool: boolean;
+const lru = new QuickLRU<string, number>({ maxSize: 1000 });
+new QuickLRU<string, number>(); // $ExpectError
 
-const lru = new QuickLRU<string, number>({maxSize: 1000});
-
-lru.set('🦄', 1).set('🌈', 2);
-numu = lru.get('🦄');
-bool = lru.has('🦄');
-numu = lru.peek('🦄');
-lru.delete('🦄');
-lru.clear();
-num = lru.size;
+lru.set('🦄', 1).set('🌈', 2); // $ExpectType QuickLRU<string, number>
+lru.get('🦄'); // $ExpectType number | undefined
+lru.has('🦄'); // $ExpectType boolean
+lru.peek('🦄'); // $ExpectType number | undefined
+lru.delete('🦄'); // $ExpectType boolean
+lru.clear(); // $ExpectType void
+lru.size; // $ExpectType number
 
 for (const [key, value] of lru) {
-    str = key;
-    num = value;
+    key; // $ExpectType string
+    value; // $ExpectType number
 }
 
 for (const key of lru.keys()) {
-    str = key;
+    key; // $ExpectType string
 }
 
 for (const value of lru.values()) {
-    num = value;
+    value; // $ExpectType number
 }

types/quick-lru/tsconfig.json

@@ -21,4 +21,4 @@
         "index.d.ts",
         "quick-lru-tests.ts"
     ]
-}
+}

types/quick-lru/v1/index.d.ts

@@ -0,0 +1,26 @@
+// Type definitions for quick-lru 1.1
+// Project: https://github.com/sindresorhus/quick-lru#readme
+// Definitions by: BendingBender <https://github.com/BendingBender>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+export = QuickLRU;
+
+declare class QuickLRU<K, V> implements Iterable<[K, V]> {
+    readonly size: number;
+    constructor(options?: QuickLRU.Options);
+    [Symbol.iterator](): Iterator<[K, V]>;
+    set(key: K, value: V): this;
+    get(key: K): V | undefined;
+    has(key: K): boolean;
+    peek(key: K): V | undefined;
+    delete(key: K): void;
+    clear(): void;
+    keys(): Iterable<K>;
+    values(): Iterable<V>;
+}
+
+declare namespace QuickLRU {
+    interface Options {
+        maxSize: number;
+    }
+}

types/quick-lru/v1/quick-lru-tests.ts

@@ -0,0 +1,29 @@
+import QuickLRU = require('quick-lru');
+
+let num: number;
+let numu: number | undefined;
+let str: string;
+let bool: boolean;
+
+const lru = new QuickLRU<string, number>({maxSize: 1000});
+
+lru.set('🦄', 1).set('🌈', 2);
+numu = lru.get('🦄');
+bool = lru.has('🦄');
+numu = lru.peek('🦄');
+lru.delete('🦄');
+lru.clear();
+num = lru.size;
+
+for (const [key, value] of lru) {
+    str = key;
+    num = value;
+}
+
+for (const key of lru.keys()) {
+    str = key;
+}
+
+for (const value of lru.values()) {
+    num = value;
+}

types/quick-lru/v1/tsconfig.json

@@ -0,0 +1,29 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "target": "es2015",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../../",
+        "typeRoots": [
+            "../../"
+        ],
+        "paths": {
+            "quick-lru": [
+                "quick-lru/v1"
+            ]
+        },
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "quick-lru-tests.ts"
+    ]
+}

types/quick-lru/v1/tslint.json

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