Quotesy

types/quotesy/index.d.ts

@@ -0,0 +1,32 @@
+// Type definitions for quotesy 1.0
+// Project: https://github.com/dwyl/quotes#readme
+// Definitions by: Nate Silva <https://github.com/natesilva>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/**
+ * Returns an Array of Quote Objects
+ */
+export function parse_json(): Quote[];
+
+/**
+ * Returns a random quote from the list
+ */
+export function random(): Quote;
+
+/**
+ * Returns a random quote for a specific tag
+ * @param tag the tag to search for
+ */
+export function random_by_tag(tag: string): Quote;
+
+/** A single quote from the database */
+export interface Quote {
+    /** The author of the quote */
+    author: string;
+    /** The text of the quote */
+    text: string;
+    /** Comma-separated list of words associated with the quote */
+    tags?: string;
+    /** A URL where the origin of the quote can be verified */
+    source?: string;
+}

types/quotesy/quotesy-tests.ts

@@ -0,0 +1,5 @@
+import quotesy = require("quotesy");
+
+quotesy.parse_json(); // $ExpectType Quote[]
+quotesy.random(); // $ExpectType Quote
+quotesy.random_by_tag(""); // $ExpectType Quote

types/quotesy/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",
+        "quotesy-tests.ts"
+    ]
+}

types/quotesy/tslint.json

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