Merge c61d45e into eaf33a5

package.json

@@ -17,13 +17,14 @@
   },
   "main": "index.js",
   "scripts": {
-    "test": "make test"
+    "test": "make test && check-dts"
   },
   "dependencies": {
     "js-yaml": "^3.13.1"
   },
   "devDependencies": {
     "brfs": "^2.0.2",
+    "check-dts": "^0.3.0",
     "coveralls": "^3.0.9",
     "istanbul": "^0.4.5",
     "standard": "^6.0.4",

test/index.errors.ts

@@ -0,0 +1,78 @@
+import fm from '../'
+
+type Attributes = {
+  title: string,
+  description: string
+}
+
+const file = `
+---
+title: Just hack'n
+description: Nothing to see here
+---
+
+This is some text about some stuff that happened sometime ago`;
+
+let nullBox: null;
+
+{
+  /* ===================== fm ===================== */
+
+  {
+    // THROWS 1 arguments, but got 0.
+    fm()
+  }
+
+  {
+    // THROWS Argument of type 'null' is not assignable to parameter of type 'string'.
+    fm(null)
+  }
+
+  {
+
+    // THROWS 'FrontMatterResult<unknown>' is not assignable to type 'null'.
+    nullBox = fm(file);
+
+    // THROWS 'FrontMatterResult<Attributes>' is not assignable to type 'null'.
+    nullBox = fm<Attributes>(file);
+  }
+
+  {
+
+    let {attributes, body, bodyBegin, frontmatter} = fm<Attributes>(file);
+
+    // THROWS Property 'foo' does not exist on type 'Attributes'.
+    attributes.foo;
+
+    // THROWS Type 'string' is not assignable to type 'null'.
+    nullBox = body
+
+    // THROWS Type 'number' is not assignable to type 'null'.
+    nullBox = bodyBegin
+
+    // THROWS Type 'string | undefined' is not assignable to type 'null'.
+    nullBox = frontmatter
+  }
+}
+
+{
+  /* ===================== fm.test ===================== */
+
+  {
+    // THROWS 1 arguments, but got 0.
+    fm.test()
+  }
+
+  {
+    // THROWS Argument of type 'null' is not assignable to parameter of type 'string'.
+    fm.test(null)
+  }
+
+  {
+
+    // THROWS Type 'boolean' is not assignable to type 'null'.
+    nullBox = fm.test(file)
+  }
+}
+
+console.log(nullBox);

test/index.types.ts

@@ -0,0 +1,46 @@
+import fm from '../'
+
+type Attributes = {
+  title: string,
+  description: string
+}
+
+const file = `
+---
+title: Just hack'n
+description: Nothing to see here
+---
+
+This is some text about some stuff that happened sometime ago`;
+
+{
+  /* ===================== fm ===================== */
+
+  {
+    fm(file)
+  }
+
+  {
+    const { attributes, body, bodyBegin, frontmatter } = fm<Attributes>(file);
+    console.log(attributes.title);
+    console.log(attributes.description);
+    console.log(body);
+    console.log(bodyBegin);
+    console.log(frontmatter);
+  }
+}
+
+{
+  /* ===================== fm.test ===================== */
+
+  {
+    fm.test(file)
+  }
+
+  {
+    let resultTest: boolean;
+
+    resultTest = fm.test(file);
+    console.log(resultTest);
+  }
+}