Merge pull request #17 from Janpot/strict-types

Strictly type

Author: Janpot

package-lock.json

@@ -4,8 +4,9 @@
   "description": "Microdata to json and json-ld parser",
   "main": "src/index.js",
   "scripts": {
-    "test": "npm run lint && npm run jest",
+    "test": "npm run lint && npm run tsc && npm run jest",
     "jest": "jest",
+    "tsc": "tsc",
     "watch:jest": "npm run jest -- -w",
     "lint": "semistandard --verbose | snazzy",
     "download-tests": "node ./scripts/download-tests.js",
@@ -26,12 +27,14 @@
   },
   "homepage": "https://github.com/Janpot/microdata-node",
   "devDependencies": {
+    "@types/node": "^13.13.5",
     "jest": "^26.0.1",
     "jsonld": "^3.1.0",
     "n3": "^1.3.6",
     "request": "^2.51.0",
     "semistandard": "^14.2.0",
-    "snazzy": "^8.0.0"
+    "snazzy": "^8.0.0",
+    "typescript": "^3.8.3"
   },
   "dependencies": {
     "domutils": "^2.1.0",

package.json

@@ -1,32 +1,61 @@
-'use strict';
-
 const microdataToRdf = require('./microdataToRdf');
 const rdfToJsonld = require('./rdfToJsonld');
 const rdfToJson = require('./rdfToJson');
 
+/**
+ * @typedef {{ subPropertyOf?: string, equivalentProperty?: string }} VocabularyProperty
+ * @typedef {{ properties?: { [name: string]: VocabularyProperty } }} Vocabulary
+ * @typedef {{ [id: string]: Vocabulary }} Registry
+ * @typedef {{
+ *   base: string
+ *   registry: Registry
+ *   strict: boolean
+ *   useRdfType: boolean
+ *   useNativeTypes: boolean
+ * }} Config
+ */
+
+/**
+  * @param {string} url
+  * @returns {string}
+  */
 function removeHashFragment (url) {
   return url.replace(/#[^#/?]$/, '');
 }
 
-function normalizeConfig (config) {
-  config = {
-    base: '',
-    registry: {},
-    strict: false,
-    useRdfType: false,
-    useNativeTypes: true,
-    ...config
+/**
+ * @param {Config} config
+ * @returns {Config}
+ */
+function normalizeConfig ({
+  base = '',
+  registry = /** @type {Registry} */({}),
+  strict = false,
+  useRdfType = false,
+  useNativeTypes = true
+} = /** @type {Partial<Config>} */({})) {
+  return {
+    base: removeHashFragment(base || ''),
+    registry,
+    strict,
+    useRdfType,
+    useNativeTypes
   };
-
-  config.base = removeHashFragment(config.base || '');
-  return config;
 }
 
+/**
+ * @param {string} microdataHtml
+ * @param {Config} config
+ */
 function toJsonld (microdataHtml, config) {
   config = normalizeConfig(config);
   return rdfToJsonld(microdataToRdf(microdataHtml, config), config);
 }
 
+/**
+ * @param {string} microdataHtml
+ * @param {Config} config
+ */
 function toJson (microdataHtml, config) {
   config = normalizeConfig(config);
   return rdfToJson(microdataToRdf(microdataHtml, config), config);