feat: add type definitions (#4)

* add TypeScript typings * Apply suggestions from code review Co-authored-by: Luke Edwards <[email protected]>
lukeed · Sep 8, 2020 · 2e5c7f8 · 2e5c7f8
1 parent 9cd75ab
commit 2e5c7f8
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,14 @@
+declare interface Options {
+    max?: number;
+    maxAge?: number;
+    stale?: boolean;
+}
+
+declare class Cache<K, V> extends Map<K, V> {
+    constructor(options?: Options | number);
+    get(key: K, refresh?: boolean): V | undefined;
+    peek(key: K): V | undefined;
+    set(key: K, value: V, maxAge?: number): this;
+}
+
+export = Cache;
diff --git a/package.json b/package.json
@@ -2,8 +2,9 @@
   "name": "tmp-cache",
   "version": "1.0.0",
   "repository": "lukeed/tmp-cache",
-  "description": "A least-recently-used cache manager in 35 lines of code",
+  "description": "A least-recently-used cache in 35 lines of code",
   "main": "lib/index.js",
+  "types": "index.d.ts",
   "license": "MIT",
   "author": {
     "name": "Luke Edwards",
@@ -17,6 +18,7 @@
     "test": "tape test/*.js | tap-spec"
   },
   "files": [
+    "*.d.ts",
     "lib"
   ],
   "keywords": [

diff --git a/readme.md b/readme.md
@@ -1,6 +1,6 @@
 # tmp-cache [![Build Status](https://travis-ci.org/lukeed/tmp-cache.svg?branch=master)](https://travis-ci.org/lukeed/tmp-cache)
 
-> A least-recently-used cache manager in 35 lines of code~!
+> A least-recently-used cache in 35 lines of code~!
 
 LRU caches operate on a first-in-first-out queue. This means that the first item is the oldest and will therefore be deleted once the `max` limit has been reached.