Refactor TypeScript definition to CommonJS compatible export (#12)

index.d.ts

@@ -1,73 +1,90 @@
-export interface Options {
-	/**
-	 * The maximum number of items before evicting the least recently used items.
-	 */
-	readonly maxSize: number;
+declare namespace QuickLRU {
+	interface Options {
+		/**
+		The maximum number of items before evicting the least recently used items.
+		*/
+		readonly maxSize: number;
+	}
 }
 
 declare class QuickLRU<KeyType extends unknown, ValueType extends unknown>
 	implements Iterable<[KeyType, ValueType]> {
 	/**
-	 * The stored item count.
-	 */
+	The stored item count.
+	*/
 	readonly size: number;
 
 	/**
-	 * Simple ["Least Recently Used" (LRU) cache](https://en.m.wikipedia.org/wiki/Cache_replacement_policies#Least_Recently_Used_.28LRU.29).
-	 *
-	 * The instance is [`iterable`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Iteration_protocols) so you can use it directly in a [`for…of`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Statements/for...of) loop.
-	 */
-	constructor(options: Options);
+	Simple ["Least Recently Used" (LRU) cache](https://en.m.wikipedia.org/wiki/Cache_replacement_policies#Least_Recently_Used_.28LRU.29).
+
+	The instance is [`iterable`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Iteration_protocols) so you can use it directly in a [`for…of`](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Statements/for...of) loop.
+
+	@example
+	```
+	import QuickLRU = require('quick-lru');
+
+	const lru = new QuickLRU({maxSize: 1000});
+
+	lru.set('🦄', '🌈');
+
+	lru.has('🦄');
+	//=> true
+
+	lru.get('🦄');
+	//=> '🌈'
+	```
+	*/
+	constructor(options: QuickLRU.Options);
 
 	[Symbol.iterator](): IterableIterator<[KeyType, ValueType]>;
 
 	/**
-	 * Set an item.
-	 *
-	 * @returns The list instance.
-	 */
+	Set an item.
+
+	@returns The list instance.
+	*/
 	set(key: KeyType, value: ValueType): this;
 
 	/**
-	 * Get an item.
-	 *
-	 * @returns The stored item or `undefined`.
-	 */
+	Get an item.
+
+	@returns The stored item or `undefined`.
+	*/
 	get(key: KeyType): ValueType | undefined;
 
 	/**
-	 * Check if an item exists.
-	 */
+	Check if an item exists.
+	*/
 	has(key: KeyType): boolean;
 
 	/**
-	 * Get an item without marking it as recently used.
-	 *
-	 * @returns The stored item or `undefined`.
-	 */
+	Get an item without marking it as recently used.
+
+	@returns The stored item or `undefined`.
+	*/
 	peek(key: KeyType): ValueType | undefined;
 
 	/**
-	 * Delete an item.
-	 *
-	 * @returns `true` if the item is removed or `false` if the item doesn't exist.
-	 */
+	Delete an item.
+
+	@returns `true` if the item is removed or `false` if the item doesn't exist.
+	*/
 	delete(key: KeyType): boolean;
 
 	/**
-	 * Delete all items.
-	 */
+	Delete all items.
+	*/
 	clear(): void;
 
 	/**
-	 * Iterable for all the keys.
-	 */
+	Iterable for all the keys.
+	*/
 	keys(): IterableIterator<KeyType>;
 
 	/**
-	 * Iterable for all the values.
-	 */
+	Iterable for all the values.
+	*/
 	values(): IterableIterator<ValueType>;
 }
 
-export default QuickLRU;
+export = QuickLRU;

index.js

@@ -112,4 +112,3 @@ class QuickLRU {
 }
 
 module.exports = QuickLRU;
-module.exports.default = QuickLRU;

index.test-d.ts

@@ -1,5 +1,5 @@
-import {expectType} from 'tsd-check';
-import QuickLRU from '.';
+import {expectType} from 'tsd';
+import QuickLRU = require('.');
 
 const lru = new QuickLRU<string, number>({maxSize: 1000});
 

package.json

@@ -13,7 +13,7 @@
 		"node": ">=8"
 	},
 	"scripts": {
-		"test": "xo && nyc ava && tsd-check"
+		"test": "xo && nyc ava && tsd"
 	},
 	"files": [
 		"index.js",
@@ -33,10 +33,10 @@
 		"buffer"
 	],
 	"devDependencies": {
-		"ava": "^1.3.1",
-		"coveralls": "^3.0.1",
-		"nyc": "^13.1.0",
-		"tsd-check": "^0.3.0",
+		"ava": "^1.4.1",
+		"coveralls": "^3.0.3",
+		"nyc": "^13.3.0",
+		"tsd": "^0.7.2",
 		"xo": "^0.24.0"
 	}
 }