Add TypeScript definitions

Closes GH-7. Closes GH-10. Reviewed-by: Titus Wormer <[email protected]>
wooorm · Sep 9, 2018 · 6d142f4 · 6d142f4
1 parent 0503d8e
commit 6d142f4
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,26 @@
+class List <T extends List.Item> {
+  static of<T extends List.Item>(...items: T[]): List<T>
+  static from<T extends List.Item>(items: T[]): List<T>
+
+  head: T | null
+  tail: T | null
+
+  constructor(...items: T[])
+  toArray(): T[]
+  prepend<T>(item: T): T
+  append<T>(item: T): T
+}
+
+namespace List {
+  export class Item {
+    prev: Item
+    next: Item
+    list: List
+
+    detach(): this
+    prepend<T extends Item>(item: T): T
+    append<T extends Item>(item: T): T
+  }
+}
+
+export = List