Merge pull request #15 from mtowers/update-docs

Update Documentation

Author: happycodelucky

.gitignore

@@ -149,4 +149,6 @@ node_modules
 
 # Generared sources
 dev
-dist
+dist
+
+yarn.lock

README.md

@@ -38,7 +38,8 @@
     "reflect-metadata": "*"
   },
   "scripts": {
-    "test": "nyc mocha -r ts-node/register -r test/prepare test/**/*.spec.ts"
+    "build": "rm -rf ./lib; rm -rf ./dts; npx tsc --project ./tsconfig.json",
+    "test": "nyc mocha -r ts-node/register test/**/*.spec.ts"
   },
   "nyc": {
     "extension": [

lib/json/json-decorators.js

@@ -57,7 +57,7 @@ export function jsonDecodable(options?: JsonDecodableOptions) {
 }
 
 /**
- * Json schema as used by a JSON decodeable object
+ * Json schema as used by a JSON decodable object
  * TODO: Use an interface describing the supported schema version (not available in ajv)
  */
 export interface JsonDecodableSchema extends Record<string, any> {
@@ -219,7 +219,7 @@ export function jsonType(
 //
 
 /**
- * Declares a function as being the decoder class factory, returning the class to instatiate with the JSON decoder
+ * Declares a function as being the decoder class factory, returning the class to instantiate with the JSON decoder
  *
  * @example
  *   @jsonDecoderFactory

lib/marshallers/date-marshaller.js

@@ -44,7 +44,7 @@ export function toDate(value: any, strict: boolean = false): Date | undefined {
     if (typeof value === 'number') {
         if (Number.isNaN(value) || value < 0) {
             if (strict) {
-                throw new TypeError(`'${value}' is not a valid URL`)
+                throw new TypeError(`'${value}' is not a valid date`)
             }
 
             return undefined
@@ -54,7 +54,7 @@ export function toDate(value: any, strict: boolean = false): Date | undefined {
     }
 
     if (strict) {
-        throw new TypeError(`'${value}' is not a valid URL`)
+        throw new TypeError(`'${value}' is not a valid date`)
     }
 
     return undefined