generic-type-guard - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

dist/combinators/interface.d.ts

 import { MappedTypeGuard, PartialTypeGuard, TypeGuard } from "../guards";
+/**
+ * Fluent Builder pattern for creating guards for interface types.
+ */
 export interface InterfaceBuilder<T extends {}> {
+    /**
+     * Finalise and return the type guard which has been built.
+     */
     get(): TypeGuard<T>;
+    /**
+     * Add a free-form type guard to this interface as a union.
+     */
     with<V>(ptv: PartialTypeGuard<{}, V>): InterfaceBuilder<T & V>;
+    /**
+     * Add a single property to the interface.
+     *
+     * @param key The string key of the property.
+     * @param ptv The type guard for this property.
+     */
     withProperty<K extends string, V>(key: K, ptv: TypeGuard<V>): InterfaceBuilder<T & {
         [prop in K]: V;
     }>;
+    /**
+     * Add a string index signature to the interface.
+     *
+     * @param value The type guard for values accessed by the index signature.
+     * @param enforce
+     *   Whether to enforce that there is at least one property already set. Be careful setting this to false, you will
+     *   get some unexpected outputs, for instance arrays will have a string index signature.
+     */
     withStringIndexSignature<V>(value: TypeGuard<V>, enforce?: boolean): InterfaceBuilder<T & {
         [prop: string]: V;
     }>;
+    /**
+     * Add a numeric index signature to the interface.
+     *
+     * @param value The type guard for values accessed by the index signature.
+     * @param enforce
+     *   Whether to enforce that there is at least one property already set. Be careful setting this to false, you will
+     *   get some unexpected outputs, for instance arrays will have a string index signature.
+     */
     withNumericIndexSignature<V>(value: TypeGuard<V>, enforce?: boolean): InterfaceBuilder<T & {
         [i: number]: V;
     }>;
+    /**
+     * Add many properties to the interface at once.
+     *
+     * @param props A map of properties to guards to apply to the interface.
+     */
     withProperties<V>(props: MappedTypeGuard<V>): InterfaceBuilder<T & V>;
 }
 /**
- * A small class to help with constructing interface checkers.
+ * A small class to help with constructing interface guards.
  */
@@ -19,0 +55,0 @@ export declare class IsInterface implements InterfaceBuilder<{}> {

dist/combinators/interface.js

 "use strict";
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (Object.hasOwnProperty.call(mod, k)) result[k] = mod[k];
+    result["default"] = mod;
+    return result;
+};
 exports.__esModule = true;
-var o = require("../objects");
+var o = __importStar(require("../objects"));
+var functions_1 = require("./functions");
 var primitives_1 = require("../primitives");
-var functions_1 = require("./functions");
 /**
@@ -37,3 +44,3 @@ * Internal class used to represent each step in the building process.
 /**
- * A small class to help with constructing interface checkers.
+ * A small class to help with constructing interface guards.
  */
@@ -66,2 +73,2 @@ var IsInterface = /** @class */ (function () {
 exports.IsInterface = IsInterface;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbWJpbmF0b3JzL2ludGVyZmFjZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUNBLDhCQUFnQztBQUNoQyw0Q0FBNkM7QUFDN0MseUNBQTZDO0FBYTdDOztHQUVHO0FBQ0g7SUFHRSx1QkFBbUIsR0FBNEI7UUFDN0MsSUFBSSxDQUFDLEdBQUcsR0FBRyxHQUFHLENBQUM7SUFDakIsQ0FBQztJQUVNLDJCQUFHLEdBQVY7UUFBQSxpQkFFQztRQURDLE9BQU8sVUFBQyxHQUFHLElBQWUsT0FBQSx5QkFBWSxDQUFDLEdBQUcsQ0FBQyxJQUFJLEtBQUksQ0FBQyxHQUFHLENBQUMsR0FBRyxDQUFDLEVBQWxDLENBQWtDLENBQUM7SUFDL0QsQ0FBQztJQUVNLHdCQUFBLE1BQUksQ0FBQSxHQUFYLFVBQWUsR0FBNEI7UUFDekMsT0FBTyxJQUFJLGFBQWEsQ0FBUSwwQkFBYyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUNqRSxDQUFDO0lBRU0sb0NBQVksR0FBbkIsVUFBeUMsR0FBTSxFQUFFLEdBQWlCO1FBQ2hFLE9BQU8sSUFBSSxhQUFhLENBQUMsMEJBQWMsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQyxXQUFXLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUM5RSxDQUFDO0lBRU0sZ0RBQXdCLEdBQS9CLFVBQW1DLEtBQW1CLEVBQUUsT0FBdUI7UUFBdkIsd0JBQUEsRUFBQSxjQUF1QjtRQUU3RSxPQUFPLElBQUksYUFBYSxDQUFDLDBCQUFjLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUMsdUJBQXVCLENBQUMsS0FBSyxFQUFFLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNoRyxDQUFDO0lBRU0saURBQXlCLEdBQWhDLFVBQW9DLEtBQW1CLEVBQUUsT0FBdUI7UUFBdkIsd0JBQUEsRUFBQSxjQUF1QjtRQUU5RSxPQUFPLElBQUksYUFBYSxDQUFDLDBCQUFjLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUMsd0JBQXdCLENBQUMsS0FBSyxFQUFFLE9BQU8sQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUNqRyxDQUFDO0lBRU0sc0NBQWMsR0FBckIsVUFBeUIsS0FBeUI7UUFDaEQsT0FBTyxJQUFJLGFBQWEsQ0FBQywwQkFBYyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDLGFBQWEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDLENBQUM7SUFDN0UsQ0FBQztJQUNILG9CQUFDO0FBQUQsQ0FBQyxBQWhDRCxJQWdDQztBQUVEOztHQUVHO0FBQ0g7SUFBQTtJQTBCQSxDQUFDO0lBekJRLHlCQUFHLEdBQVY7UUFDRSxPQUFPLHlCQUFZLENBQUM7SUFDdEIsQ0FBQztJQUVNLHNCQUFBLE1BQUksQ0FBQSxHQUFYLFVBQWUsR0FBNEI7UUFDekMsT0FBTyxJQUFJLGFBQWEsQ0FBQyxHQUFHLENBQUMsQ0FBQztJQUNoQyxDQUFDO0lBRU0sa0NBQVksR0FBbkIsVUFBeUMsR0FBTSxFQUFFLEdBQWlCO1FBQ2hFLE9BQU8sSUFBSSxhQUFhLENBQUMsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUNwRCxDQUFDO0lBRU0sOENBQXdCLEdBQS9CLFVBQW1DLEtBQW1CLEVBQUUsT0FBdUI7UUFBdkIsd0JBQUEsRUFBQSxjQUF1QjtRQUU3RSxPQUFPLElBQUksYUFBYSxDQUFDLENBQUMsQ0FBQyx1QkFBdUIsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUN0RSxDQUFDO0lBRU0sK0NBQXlCLEdBQWhDLFVBQW9DLEtBQW1CLEVBQUUsT0FBdUI7UUFBdkIsd0JBQUEsRUFBQSxjQUF1QjtRQUU5RSxPQUFPLElBQUksYUFBYSxDQUFDLENBQUMsQ0FBQyx3QkFBd0IsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQztJQUN2RSxDQUFDO0lBRU0sb0NBQWMsR0FBckIsVUFBeUIsS0FBeUI7UUFDaEQsT0FBTyxJQUFJLGFBQWEsQ0FBQyxDQUFDLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUM7SUFDbkQsQ0FBQztJQUNILGtCQUFDO0FBQUQsQ0FBQyxBQTFCRCxJQTBCQztBQTFCWSxrQ0FBVyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJmYWNlLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NvbWJpbmF0b3JzL2ludGVyZmFjZS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7QUFBQSw0Q0FBZ0M7QUFFaEMseUNBQTZDO0FBQzdDLDRDQUE2QztBQXNEN0M7O0dBRUc7QUFDSDtJQUdFLHVCQUFtQixHQUE0QjtRQUM3QyxJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztJQUNqQixDQUFDO0lBRU0sMkJBQUcsR0FBVjtRQUFBLGlCQUVDO1FBREMsT0FBTyxVQUFDLEdBQUcsSUFBZSxPQUFBLHlCQUFZLENBQUMsR0FBRyxDQUFDLElBQUksS0FBSSxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsRUFBbEMsQ0FBa0MsQ0FBQztJQUMvRCxDQUFDO0lBRU0sd0JBQUEsTUFBSSxDQUFBLEdBQVgsVUFBZSxHQUE0QjtRQUN6QyxPQUFPLElBQUksYUFBYSxDQUFRLDBCQUFjLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQyxDQUFDO0lBQ2pFLENBQUM7SUFFTSxvQ0FBWSxHQUFuQixVQUF5QyxHQUFNLEVBQUUsR0FBaUI7UUFDaEUsT0FBTyxJQUFJLGFBQWEsQ0FBQywwQkFBYyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQyxDQUFDLFdBQVcsQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQzlFLENBQUM7SUFFTSxnREFBd0IsR0FBL0IsVUFBbUMsS0FBbUIsRUFBRSxPQUFjO1FBQWQsd0JBQUEsRUFBQSxjQUFjO1FBQ3BFLE9BQU8sSUFBSSxhQUFhLENBQUMsMEJBQWMsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQyx1QkFBdUIsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ2hHLENBQUM7SUFFTSxpREFBeUIsR0FBaEMsVUFBb0MsS0FBbUIsRUFBRSxPQUFjO1FBQWQsd0JBQUEsRUFBQSxjQUFjO1FBQ3JFLE9BQU8sSUFBSSxhQUFhLENBQUMsMEJBQWMsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLENBQUMsQ0FBQyx3QkFBd0IsQ0FBQyxLQUFLLEVBQUUsT0FBTyxDQUFDLENBQUMsQ0FBQyxDQUFDO0lBQ2pHLENBQUM7SUFFTSxzQ0FBYyxHQUFyQixVQUF5QixLQUF5QjtRQUNoRCxPQUFPLElBQUksYUFBYSxDQUFDLDBCQUFjLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxDQUFDLENBQUMsYUFBYSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUM3RSxDQUFDO0lBQ0gsb0JBQUM7QUFBRCxDQUFDLEFBOUJELElBOEJDO0FBRUQ7O0dBRUc7QUFDSDtJQUFBO0lBd0JBLENBQUM7SUF2QlEseUJBQUcsR0FBVjtRQUNFLE9BQU8seUJBQVksQ0FBQztJQUN0QixDQUFDO0lBRU0sc0JBQUEsTUFBSSxDQUFBLEdBQVgsVUFBZSxHQUE0QjtRQUN6QyxPQUFPLElBQUksYUFBYSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQ2hDLENBQUM7SUFFTSxrQ0FBWSxHQUFuQixVQUF5QyxHQUFNLEVBQUUsR0FBaUI7UUFDaEUsT0FBTyxJQUFJLGFBQWEsQ0FBQyxDQUFDLENBQUMsV0FBVyxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQyxDQUFDO0lBQ3BELENBQUM7SUFFTSw4Q0FBd0IsR0FBL0IsVUFBbUMsS0FBbUIsRUFBRSxPQUFjO1FBQWQsd0JBQUEsRUFBQSxjQUFjO1FBQ3BFLE9BQU8sSUFBSSxhQUFhLENBQUMsQ0FBQyxDQUFDLHVCQUF1QixDQUFDLEtBQUssRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDO0lBQ3RFLENBQUM7SUFFTSwrQ0FBeUIsR0FBaEMsVUFBb0MsS0FBbUIsRUFBRSxPQUFjO1FBQWQsd0JBQUEsRUFBQSxjQUFjO1FBQ3JFLE9BQU8sSUFBSSxhQUFhLENBQUMsQ0FBQyxDQUFDLHdCQUF3QixDQUFDLEtBQUssRUFBRSxPQUFPLENBQUMsQ0FBQyxDQUFDO0lBQ3ZFLENBQUM7SUFFTSxvQ0FBYyxHQUFyQixVQUF5QixLQUF5QjtRQUNoRCxPQUFPLElBQUksYUFBYSxDQUFDLENBQUMsQ0FBQyxhQUFhLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQztJQUNuRCxDQUFDO0lBQ0gsa0JBQUM7QUFBRCxDQUFDLEFBeEJELElBd0JDO0FBeEJZLGtDQUFXIn0=

dist/combinators/intersectionof.d.ts

@@ -8,4 +8,10 @@ import { PartialTypeGuard } from "../guards";
     constructor(ptt: PartialTypeGuard<B, T>);
+    /**
+     * Finalise and return the partial type guard for this builder.
+     */
     get(): PartialTypeGuard<B, T>;
+    /**
+     * Add a new option for this intersection.
+     */
     with<U extends B>(ptu: PartialTypeGuard<B, U>): IntersectionOf<B, T & U>;
 }

dist/combinators/intersectionof.js

@@ -11,5 +11,11 @@ "use strict";
     }
+    /**
+     * Finalise and return the partial type guard for this builder.
+     */
     IntersectionOf.prototype.get = function () {
         return this.ptt;
     };
+    /**
+     * Add a new option for this intersection.
+     */
     IntersectionOf.prototype["with"] = function (ptu) {
@@ -21,2 +27,2 @@ return new IntersectionOf(functions_1.isIntersection(this.ptt, ptu));
 exports.IntersectionOf = IntersectionOf;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJzZWN0aW9ub2YuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tYmluYXRvcnMvaW50ZXJzZWN0aW9ub2YudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFDQSx5Q0FBNkM7QUFFN0M7O0dBRUc7QUFDSDtJQUdFLHdCQUFZLEdBQTJCO1FBQ3JDLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO0lBQ2pCLENBQUM7SUFFTSw0QkFBRyxHQUFWO1FBQ0UsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDO0lBQ2xCLENBQUM7SUFFTSx5QkFBQSxNQUFJLENBQUEsR0FBWCxVQUF5QixHQUEyQjtRQUNsRCxPQUFPLElBQUksY0FBYyxDQUFDLDBCQUFjLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQyxDQUFDO0lBQzNELENBQUM7SUFDSCxxQkFBQztBQUFELENBQUMsQUFkRCxJQWNDO0FBZFksd0NBQWMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW50ZXJzZWN0aW9ub2YuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY29tYmluYXRvcnMvaW50ZXJzZWN0aW9ub2YudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSx5Q0FBNkM7QUFHN0M7O0dBRUc7QUFDSDtJQUdFLHdCQUFZLEdBQTJCO1FBQ3JDLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO0lBQ2pCLENBQUM7SUFFRDs7T0FFRztJQUNJLDRCQUFHLEdBQVY7UUFDRSxPQUFPLElBQUksQ0FBQyxHQUFHLENBQUM7SUFDbEIsQ0FBQztJQUVEOztPQUVHO0lBQ0kseUJBQUEsTUFBSSxDQUFBLEdBQVgsVUFBeUIsR0FBMkI7UUFDbEQsT0FBTyxJQUFJLGNBQWMsQ0FBQywwQkFBYyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUMzRCxDQUFDO0lBQ0gscUJBQUM7QUFBRCxDQUFDLEFBcEJELElBb0JDO0FBcEJZLHdDQUFjIn0=

dist/combinators/unionof.d.ts

@@ -8,4 +8,10 @@ import { PartialTypeGuard } from "../guards";
     constructor(ptt: PartialTypeGuard<B, T>);
+    /**
+     * Finalise and return the partial type guard for this builder.
+     */
     get(): PartialTypeGuard<B, T>;
-    with<V extends B>(ptv: PartialTypeGuard<B, V>): UnionOf<B, T | V>;
+    /**
+     * Add a new option for this union.
+     */
+    with<U extends B>(ptv: PartialTypeGuard<B, U>): UnionOf<B, T | U>;
 }

dist/combinators/unionof.js

@@ -11,5 +11,11 @@ "use strict";
     }
+    /**
+     * Finalise and return the partial type guard for this builder.
+     */
     UnionOf.prototype.get = function () {
         return this.ptt;
     };
+    /**
+     * Add a new option for this union.
+     */
     UnionOf.prototype["with"] = function (ptv) {
@@ -21,2 +27,2 @@ return new UnionOf(functions_1.isUnion(this.ptt, ptv));
 exports.UnionOf = UnionOf;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidW5pb25vZi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb21iaW5hdG9ycy91bmlvbm9mLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EseUNBQXNDO0FBRXRDOztHQUVHO0FBQ0g7SUFHRSxpQkFBWSxHQUEyQjtRQUNyQyxJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztJQUNqQixDQUFDO0lBRU0scUJBQUcsR0FBVjtRQUNFLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQztJQUNsQixDQUFDO0lBRU0sa0JBQUEsTUFBSSxDQUFBLEdBQVgsVUFBeUIsR0FBMkI7UUFDbEQsT0FBTyxJQUFJLE9BQU8sQ0FBQyxtQkFBTyxDQUFDLElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUMsQ0FBQztJQUM3QyxDQUFDO0lBQ0gsY0FBQztBQUFELENBQUMsQUFkRCxJQWNDO0FBZFksMEJBQU8ifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidW5pb25vZi5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9jb21iaW5hdG9ycy91bmlvbm9mLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQUEseUNBQXNDO0FBR3RDOztHQUVHO0FBQ0g7SUFHRSxpQkFBWSxHQUEyQjtRQUNyQyxJQUFJLENBQUMsR0FBRyxHQUFHLEdBQUcsQ0FBQztJQUNqQixDQUFDO0lBRUQ7O09BRUc7SUFDSSxxQkFBRyxHQUFWO1FBQ0UsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDO0lBQ2xCLENBQUM7SUFFRDs7T0FFRztJQUNJLGtCQUFBLE1BQUksQ0FBQSxHQUFYLFVBQXlCLEdBQTJCO1FBQ2xELE9BQU8sSUFBSSxPQUFPLENBQUMsbUJBQU8sQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQyxDQUFDLENBQUM7SUFDN0MsQ0FBQztJQUNILGNBQUM7QUFBRCxDQUFDLEFBcEJELElBb0JDO0FBcEJZLDBCQUFPIn0=

dist/examples.spec.d.ts

@@ -6,7 +6,2 @@ import * as tg from "./index";
 }
-export interface ComplexInterface extends TestInterface {
-    b: boolean;
-    maybeString?: string;
-    nullableString: string | null;
-}
 /**
@@ -20,3 +15,3 @@ * Simple way to test an interface.
  * You can then combine this PartialTypeGuard with isObject to get a full typeguard
- * from `any`. If you add properties to TestInterface or change types then this form will
+ * from `undefined`. If you add properties to TestInterface or change types then this form will
  * trigger a type error as the interfaces won't match up structurally.
@@ -29,4 +24,8 @@ */
  * This is exposed for both intersection and union combinators.
+ *
+ * If you have a complex interface like this, then the best way to deal with the type is to
+ * generate it from the guard if feasible.
  */
-export declare const isTypeSafeComplexInterface: tg.PartialTypeGuard<{}, ComplexInterface>;
+export declare const isTypeSafeComplexInterface: tg.PartialTypeGuard<{}, Record<"str", string> & Record<"num", number> & Record<"b", boolean> & Record<"maybeString", string | undefined> & Record<"nullableString", string | null>>;
+export declare type ComplexInterface = tg.GuardedType<typeof isTypeSafeComplexInterface>;
 /**
@@ -33,0 +32,0 @@ * This is the alternative syntax for defining interfaces in a bit cleaner way.

dist/guards.d.ts

@@ -1,8 +0,18 @@
-declare type Diff<T, U> = T extends U ? never : T;
-export declare type NotEmpty = Diff<unknown, null | undefined>;
+/**
+ * A partial type guard that can take a value of one type and determine if it is also a valid value of a subtype.
+ */
 export declare type PartialTypeGuard<T, U extends T> = (value: T) => value is U;
+/**
+ * A full type guard that can guard any value and determine if it is valid.
+ */
 export declare type TypeGuard<T> = PartialTypeGuard<unknown, T>;
+/**
+ * Extracts the type that is being guarded for from a type guard.
+ */
+export declare type GuardedType<T extends PartialTypeGuard<any, unknown>> = T extends PartialTypeGuard<any, infer U> ? U : never;
+/**
+ * An object of type guards based on the input type.
+ */
 export declare type MappedTypeGuard<T> = {
     [P in keyof T]: TypeGuard<T[P]>;
 };
-export {};

dist/guards.js

 "use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
 exports.__esModule = true;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ3VhcmRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2d1YXJkcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiZ3VhcmRzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2d1YXJkcy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQUEsdURBQXVEIn0=

dist/objects.d.ts

@@ -15,3 +15,3 @@ import { MappedTypeGuard, PartialTypeGuard } from "./guards";
  *
- * @param {boolean} enforce
+ * @param enforce
  *   Whether to enforce that there is at least one property already set. Be careful setting this to false, you will
@@ -26,3 +26,3 @@ *   get some unexpected outputs, for instance arrays will have a string index signature.
  *
- * @param {boolean} enforce
+ * @param enforce
  *   Whether to enforce that there is at least one property already set. Be careful setting this to false, you will
@@ -37,3 +37,3 @@ *   get some unexpected outputs, for instance objects will have a numeric index signature.
  */
-export declare const isInstance: <T extends {}>(klass: new (...args: any[]) => T) => PartialTypeGuard<unknown, T>;
+export declare const isInstance: <T extends {}>(klass: new (...args: unknown[]) => T) => PartialTypeGuard<unknown, T>;
 /**
@@ -40,0 +40,0 @@ * Validate that a given object has all the given properties

dist/objects.js

@@ -24,3 +24,3 @@ "use strict";
  *
- * @param {boolean} enforce
+ * @param enforce
  *   Whether to enforce that there is at least one property already set. Be careful setting this to false, you will
@@ -36,3 +36,3 @@ *   get some unexpected outputs, for instance arrays will have a string index signature.
                 if (value(o[prop])) {
-                    n += 1;
+                    n++;
                 }
@@ -44,2 +44,3 @@ else {
         }
+        /* eslint-disable-next-line no-magic-numbers */
         return !enforce || n > 0;
@@ -51,3 +52,3 @@ };
  *
- * @param {boolean} enforce
+ * @param enforce
  *   Whether to enforce that there is at least one property already set. Be careful setting this to false, you will
@@ -64,3 +65,3 @@ *   get some unexpected outputs, for instance objects will have a numeric index signature.
                 if (value(o[prop])) {
-                    n += 1;
+                    n++;
                 }
@@ -72,2 +73,3 @@ else {
         }
+        /* eslint-disable-next-line no-magic-numbers */
         return !enforce || n > 0;
@@ -97,2 +99,2 @@ };
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib2JqZWN0cy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9vYmplY3RzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsMkNBQXdDO0FBRXhDOztHQUVHO0FBQ1UsUUFBQSxXQUFXLEdBQ3RCLFVBQXNCLFFBQVcsRUFBRSxLQUFtQjtJQUNwRCxPQUFBLFVBQUMsQ0FBQztRQUNBLCtEQUErRDtRQUMvRCxPQUFBLEtBQUssQ0FBRSxDQUFpQyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQW5ELENBQW1EO0FBRnJELENBRXFELENBQUM7QUFFMUQ7Ozs7R0FJRztBQUNVLFFBQUEsUUFBUSxHQUNuQixVQUFzQixRQUFXLEVBQUUsS0FBbUI7SUFDcEQsT0FBQSxVQUFDLENBQUMsSUFBOEIsT0FBQSxxQkFBUSxDQUFDLENBQUMsQ0FBQyxJQUFJLG1CQUFXLENBQUMsUUFBUSxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUE5QyxDQUE4QztBQUE5RSxDQUE4RSxDQUFDO0FBRW5GOzs7Ozs7R0FNRztBQUNVLFFBQUEsdUJBQXVCLEdBQ2xDLFVBQUksS0FBbUIsRUFBRSxPQUFjO0lBQWQsd0JBQUEsRUFBQSxjQUFjO0lBQ3JDLE9BQUEsVUFBQyxDQUFDO1FBQ0EsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ1YsS0FBSyxJQUFNLElBQUksSUFBSSxDQUFDLEVBQUU7WUFDcEIsSUFBSSxLQUFLLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsQ0FBQyxFQUFFO2dCQUM3QixJQUFJLEtBQUssQ0FBRSxDQUFpQyxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUU7b0JBQ25ELENBQUMsSUFBSSxDQUFDLENBQUM7aUJBQ1I7cUJBQ0k7b0JBQ0gsT0FBTyxLQUFLLENBQUM7aUJBQ2Q7YUFDRjtTQUNGO1FBRUQsT0FBTyxDQUFDLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzNCLENBQUM7QUFkRCxDQWNDLENBQUM7QUFFTjs7Ozs7O0dBTUc7QUFDVSxRQUFBLHdCQUF3QixHQUNuQyxVQUFJLEtBQW1CLEVBQUUsT0FBYztJQUFkLHdCQUFBLEVBQUEsY0FBYztJQUNyQyxPQUFBLFVBQUMsQ0FBQztRQUNBLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUNWLEtBQUssSUFBTSxJQUFJLElBQUksQ0FBQyxFQUFFO1lBQ3BCLElBQUksQ0FBQyxLQUFLLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsQ0FBQyxFQUFFO2dCQUM5Qiw0REFBNEQ7Z0JBQzVELElBQUksS0FBSyxDQUFFLENBQWlDLENBQUMsSUFBSSxDQUFDLENBQUMsRUFBRTtvQkFDbkQsQ0FBQyxJQUFJLENBQUMsQ0FBQztpQkFDUjtxQkFDSTtvQkFDSCxPQUFPLEtBQUssQ0FBQztpQkFDZDthQUNGO1NBQ0Y7UUFFRCxPQUFPLENBQUMsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDM0IsQ0FBQztBQWZELENBZUMsQ0FBQztBQUVOOztHQUVHO0FBQ1UsUUFBQSxVQUFVLEdBQUcsVUFBZSxLQUFnQztJQUN2RSxPQUFBLFVBQUMsQ0FBQyxJQUFhLE9BQUEsQ0FBQyxZQUFZLEtBQUssRUFBbEIsQ0FBa0I7QUFBakMsQ0FBaUMsQ0FBQztBQUVwQzs7OztHQUlHO0FBQ1UsUUFBQSxhQUFhLEdBQ3hCLFVBQUksS0FBeUI7SUFDM0IsT0FBQSxVQUFDLENBQUM7UUFDQSxLQUFLLElBQU0sSUFBSSxJQUFJLEtBQUssRUFBRTtZQUN4QixJQUFJLENBQUMsbUJBQVcsQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUU7Z0JBQ3RDLE9BQU8sS0FBSyxDQUFDO2FBQ2Q7U0FDRjtRQUVELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztBQVJELENBUUMsQ0FBQyJ9
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoib2JqZWN0cy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9vYmplY3RzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBQ0EsMkNBQXdDO0FBRXhDOztHQUVHO0FBQ1UsUUFBQSxXQUFXLEdBQ3RCLFVBQXNCLFFBQVcsRUFBRSxLQUFtQjtJQUNwRCxPQUFBLFVBQUMsQ0FBQztRQUNBLCtEQUErRDtRQUMvRCxPQUFBLEtBQUssQ0FBRSxDQUFpQyxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQW5ELENBQW1EO0FBRnJELENBRXFELENBQUM7QUFFMUQ7Ozs7R0FJRztBQUNVLFFBQUEsUUFBUSxHQUNuQixVQUFzQixRQUFXLEVBQUUsS0FBbUI7SUFDcEQsT0FBQSxVQUFDLENBQUMsSUFBOEIsT0FBQSxxQkFBUSxDQUFDLENBQUMsQ0FBQyxJQUFJLG1CQUFXLENBQUMsUUFBUSxFQUFFLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQyxFQUE5QyxDQUE4QztBQUE5RSxDQUE4RSxDQUFDO0FBRW5GOzs7Ozs7R0FNRztBQUNVLFFBQUEsdUJBQXVCLEdBQ2xDLFVBQUksS0FBbUIsRUFBRSxPQUFjO0lBQWQsd0JBQUEsRUFBQSxjQUFjO0lBQ3JDLE9BQUEsVUFBQyxDQUFDO1FBQ0EsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ1YsS0FBSyxJQUFNLElBQUksSUFBSSxDQUFDLEVBQUU7WUFDcEIsSUFBSSxLQUFLLENBQUMsUUFBUSxDQUFDLElBQUksRUFBRSxFQUFFLENBQUMsQ0FBQyxFQUFFO2dCQUM3QixJQUFJLEtBQUssQ0FBRSxDQUFpQyxDQUFDLElBQUksQ0FBQyxDQUFDLEVBQUU7b0JBQ25ELENBQUMsRUFBRSxDQUFDO2lCQUNMO3FCQUNJO29CQUNILE9BQU8sS0FBSyxDQUFDO2lCQUNkO2FBQ0Y7U0FDRjtRQUVELCtDQUErQztRQUMvQyxPQUFPLENBQUMsT0FBTyxJQUFJLENBQUMsR0FBRyxDQUFDLENBQUM7SUFDM0IsQ0FBQztBQWZELENBZUMsQ0FBQztBQUVOOzs7Ozs7R0FNRztBQUNVLFFBQUEsd0JBQXdCLEdBQ25DLFVBQUksS0FBbUIsRUFBRSxPQUFjO0lBQWQsd0JBQUEsRUFBQSxjQUFjO0lBQ3JDLE9BQUEsVUFBQyxDQUFDO1FBQ0EsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1FBQ1YsS0FBSyxJQUFNLElBQUksSUFBSSxDQUFDLEVBQUU7WUFDcEIsSUFBSSxDQUFDLEtBQUssQ0FBQyxRQUFRLENBQUMsSUFBSSxFQUFFLEVBQUUsQ0FBQyxDQUFDLEVBQUU7Z0JBQzlCLDREQUE0RDtnQkFDNUQsSUFBSSxLQUFLLENBQUUsQ0FBaUMsQ0FBQyxJQUFJLENBQUMsQ0FBQyxFQUFFO29CQUNuRCxDQUFDLEVBQUUsQ0FBQztpQkFDTDtxQkFDSTtvQkFDSCxPQUFPLEtBQUssQ0FBQztpQkFDZDthQUNGO1NBQ0Y7UUFFRCwrQ0FBK0M7UUFDL0MsT0FBTyxDQUFDLE9BQU8sSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDO0lBQzNCLENBQUM7QUFoQkQsQ0FnQkMsQ0FBQztBQUVOOztHQUVHO0FBQ1UsUUFBQSxVQUFVLEdBQUcsVUFBZSxLQUFvQztJQUMzRSxPQUFBLFVBQUMsQ0FBQyxJQUFhLE9BQUEsQ0FBQyxZQUFZLEtBQUssRUFBbEIsQ0FBa0I7QUFBakMsQ0FBaUMsQ0FBQztBQUVwQzs7OztHQUlHO0FBQ1UsUUFBQSxhQUFhLEdBQ3hCLFVBQUksS0FBeUI7SUFDM0IsT0FBQSxVQUFDLENBQUM7UUFDQSxLQUFLLElBQU0sSUFBSSxJQUFJLEtBQUssRUFBRTtZQUN4QixJQUFJLENBQUMsbUJBQVcsQ0FBQyxJQUFJLEVBQUUsS0FBSyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUU7Z0JBQ3RDLE9BQU8sS0FBSyxDQUFDO2FBQ2Q7U0FDRjtRQUVELE9BQU8sSUFBSSxDQUFDO0lBQ2QsQ0FBQztBQVJELENBUUMsQ0FBQyJ9

dist/primitives.d.ts

@@ -1,2 +0,3 @@
-import { NotEmpty, PartialTypeGuard, TypeGuard } from "./guards";
+import { PartialTypeGuard, TypeGuard } from "./guards";
+declare type Diff<T, U> = T extends U ? never : T;
 /**
@@ -32,2 +33,9 @@ * Validate if a value is a javascript number.
 /**
+ * Validates that a value is one of a set of values.
+ */
+export declare const isElementOf: {
+    (): PartialTypeGuard<unknown, never>;
+    <T>(...ss: T[]): PartialTypeGuard<unknown, T>;
+};
+/**
  * Validate if a value is a specific javascript number.
@@ -39,3 +47,6 @@ */
  */
-export declare const isSingletonNumberUnion: <T extends number>(...ns: T[]) => PartialTypeGuard<unknown, T>;
+export declare const isSingletonNumberUnion: {
+    (): PartialTypeGuard<unknown, never>;
+    <T extends number>(...ss: T[]): PartialTypeGuard<unknown, T>;
+};
 /**
@@ -52,3 +63,6 @@ * Validate if a value is a string.
  */
-export declare const isSingletonStringUnion: <T extends string>(...ss: T[]) => PartialTypeGuard<unknown, T>;
+export declare const isSingletonStringUnion: {
+    (): PartialTypeGuard<unknown, never>;
+    <T extends string>(...ss: T[]): PartialTypeGuard<unknown, T>;
+};
 /**
@@ -100,3 +114,3 @@ * Validate if a value is a boolean.
  */
-export declare const isSet: TypeGuard<NotEmpty>;
+export declare const isSet: <T = unknown>(obj: T) => obj is Diff<T, null | undefined>;
 /**
@@ -123,1 +137,2 @@ * Helper for asserting nothing at all.
 export declare const isNever: (n: never) => never;
+export {};

dist/primitives.js

 "use strict";
 exports.__esModule = true;
+var MINIMUM_ARRAY_INDEX = 0;
 /**
@@ -43,2 +44,12 @@ * Validate if a value is a javascript number.
 /**
+ * Validates that a value is one of a set of values.
+ */
+exports.isElementOf = (function () {
+    var ss = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        ss[_i] = arguments[_i];
+    }
+    return function (s) { return ss.indexOf(s) >= MINIMUM_ARRAY_INDEX; };
+});
+/**
  * Validate if a value is a specific javascript number.
@@ -52,9 +63,9 @@ */
  */
-exports.isSingletonNumberUnion = function () {
-    var ns = [];
+exports.isSingletonNumberUnion = (function () {
+    var ss = [];
     for (var _i = 0; _i < arguments.length; _i++) {
-        ns[_i] = arguments[_i];
+        ss[_i] = arguments[_i];
     }
-    return function (n) { return ns.indexOf(n) >= 0; };
-};
+    return function (s) { return ss.indexOf(s) >= MINIMUM_ARRAY_INDEX; };
+});
 /**
@@ -75,3 +86,3 @@ * Validate if a value is a string.
  */
-exports.isSingletonStringUnion = function () {
+exports.isSingletonStringUnion = (function () {
     var ss = [];
@@ -81,4 +92,4 @@ for (var _i = 0; _i < arguments.length; _i++) {
     }
-    return function (s) { return ss.indexOf(s) >= 0; };
-};
+    return function (s) { return ss.indexOf(s) >= MINIMUM_ARRAY_INDEX; };
+});
 /**
@@ -161,3 +172,3 @@ * Validate if a value is a boolean.
  */
-exports.isAny = function (_a) { return true; };
+exports.isAny = function (_a) { return true; }; /* eslint-disable-line @typescript-eslint/no-unused-vars */
 /**
@@ -175,2 +186,2 @@ * Alias for isAny.
 };
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJpbWl0aXZlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9wcmltaXRpdmVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBRUE7O0dBRUc7QUFDVSxRQUFBLFFBQVEsR0FBc0IsVUFBQyxDQUFDO0lBQzNDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUSxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUM7QUFBekMsQ0FBeUMsQ0FBQztBQUU1Qzs7R0FFRztBQUNVLFFBQUEsY0FBYyxHQUFzQixVQUFDLENBQUM7SUFDakQsT0FBQSxPQUFPLENBQUMsS0FBSyxRQUFRLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxJQUFJLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO0FBQS9ELENBQStELENBQUM7QUFFbEU7Ozs7O0dBS0c7QUFDVSxRQUFBLE9BQU8sR0FBc0IsVUFBQyxDQUFDO0lBQzFDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUTtBQUFyQixDQUFxQixDQUFDO0FBRXhCOzs7O0dBSUc7QUFDVSxRQUFBLFFBQVEsR0FBRyxlQUFPLENBQUM7QUFFaEM7O0dBRUc7QUFDVSxRQUFBLFVBQVUsR0FBc0IsVUFBQyxDQUFDO0lBQzdDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUSxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO0FBQWhFLENBQWdFLENBQUM7QUFFbkU7O0dBRUc7QUFDVSxRQUFBLEtBQUssR0FBc0IsVUFBQyxDQUFDO0lBQ3hDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUSxJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDO0FBQXhDLENBQXdDLENBQUM7QUFFM0M7O0dBRUc7QUFDVSxRQUFBLGlCQUFpQixHQUFHLFVBQW1CLENBQUksSUFBbUIsT0FBQSxVQUFDLENBQUM7SUFDM0UsT0FBQSxDQUFDLEtBQUssQ0FBQztBQUFQLENBQU8sRUFEa0UsQ0FDbEUsQ0FBQztBQUVWOztHQUVHO0FBQ1UsUUFBQSxzQkFBc0IsR0FBRztJQUFtQixZQUFVO1NBQVYsVUFBVSxFQUFWLHFCQUFVLEVBQVYsSUFBVTtRQUFWLHVCQUFVOztJQUNqRSxPQUFBLFVBQUMsQ0FBQyxJQUFhLE9BQUEsRUFBRSxDQUFDLE9BQU8sQ0FBQyxDQUFRLENBQUMsSUFBSSxDQUFDLEVBQXpCLENBQXlCO0FBQXhDLENBQXdDLENBQUM7QUFFM0M7O0dBRUc7QUFDVSxRQUFBLFFBQVEsR0FBc0IsVUFBQyxDQUFDO0lBQzNDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUTtBQUFyQixDQUFxQixDQUFDO0FBRXhCOztHQUVHO0FBQ1UsUUFBQSxpQkFBaUIsR0FBRyxVQUFtQixDQUFJLElBQW1CLE9BQUEsVUFBQyxDQUFDO0lBQzNFLE9BQUEsQ0FBQyxLQUFLLENBQUM7QUFBUCxDQUFPLEVBRGtFLENBQ2xFLENBQUM7QUFFVjs7R0FFRztBQUNVLFFBQUEsc0JBQXNCLEdBQUc7SUFBbUIsWUFBVTtTQUFWLFVBQVUsRUFBVixxQkFBVSxFQUFWLElBQVU7UUFBVix1QkFBVTs7SUFDakUsT0FBQSxVQUFDLENBQUMsSUFBYSxPQUFBLEVBQUUsQ0FBQyxPQUFPLENBQUMsQ0FBUSxDQUFDLElBQUksQ0FBQyxFQUF6QixDQUF5QjtBQUF4QyxDQUF3QyxDQUFDO0FBRTNDOztHQUVHO0FBQ1UsUUFBQSxTQUFTLEdBQXVCLFVBQUMsQ0FBQztJQUM3QyxPQUFBLE9BQU8sQ0FBQyxLQUFLLFNBQVM7QUFBdEIsQ0FBc0IsQ0FBQztBQUV6Qjs7R0FFRztBQUNVLFFBQUEsTUFBTSxHQUFvQixVQUFDLENBQUM7SUFDdkMsT0FBQSxDQUFDLEtBQUssSUFBSTtBQUFWLENBQVUsQ0FBQztBQUViOztHQUVHO0FBQ1UsUUFBQSxXQUFXLEdBQXlCLFVBQUMsQ0FBQztJQUNqRCxPQUFBLE9BQU8sQ0FBQyxLQUFLLFdBQVc7QUFBeEIsQ0FBd0IsQ0FBQztBQUUzQjs7R0FFRztBQUNVLFFBQUEsVUFBVSxHQUFHLFVBQUksR0FBaUI7SUFDN0MsT0FBQSxVQUFDLENBQUMsSUFBeUIsT0FBQSxPQUFPLENBQUMsS0FBSyxXQUFXLElBQUksR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFsQyxDQUFrQztBQUE3RCxDQUE2RCxDQUFDO0FBRWhFOztHQUVHO0FBQ1UsUUFBQSxVQUFVLEdBQUcsVUFBSSxHQUFpQjtJQUM3QyxPQUFBLFVBQUMsQ0FBQyxJQUFvQixPQUFBLENBQUMsS0FBSyxJQUFJLElBQUksR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFwQixDQUFvQjtBQUExQyxDQUEwQyxDQUFDO0FBRTdDOztHQUVHO0FBQ1UsUUFBQSxTQUFTLEdBQUcsVUFBSSxHQUFpQjtJQUM1QyxPQUFBLFVBQUMsQ0FBQyxJQUFnQyxPQUFBLENBQUMsSUFBSSxJQUFJLElBQUksR0FBRyxDQUFDLENBQUMsQ0FBQyxFQUFuQixDQUFtQjtBQUFyRCxDQUFxRCxDQUFDO0FBRXhEOztHQUVHO0FBQ1UsUUFBQSxPQUFPLEdBQ2xCLFVBQUksVUFBd0IsSUFBcUIsT0FBQSxVQUFDLEdBQVk7SUFDNUQsT0FBQSxLQUFLLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxJQUFJLEdBQUcsQ0FBQyxNQUFNLENBQVUsVUFBQyxHQUFHLEVBQUUsQ0FBQyxJQUFLLE9BQUEsR0FBRyxJQUFJLFVBQVUsQ0FBQyxDQUFZLENBQUMsRUFBL0IsQ0FBK0IsRUFBRSxJQUFJLENBQUM7QUFBNUYsQ0FBNEYsRUFEN0MsQ0FDNkMsQ0FBQztBQUVqRzs7R0FFRztBQUNVLFFBQUEsV0FBVyxHQUN0QixVQUFpQixFQUEwQjtJQUN6QyxPQUFBLFVBQUMsRUFBTyxJQUFnQixPQUFBLEVBQUUsQ0FBQyxNQUFNLENBQVUsVUFBQyxHQUFHLEVBQUUsQ0FBQyxJQUFLLE9BQUEsR0FBRyxJQUFJLEVBQUUsQ0FBQyxDQUFDLENBQUMsRUFBWixDQUFZLEVBQUUsSUFBSSxDQUFDLEVBQWxELENBQWtEO0FBQTFFLENBQTBFLENBQUM7QUFFL0U7Ozs7O0dBS0c7QUFDVSxRQUFBLFlBQVksR0FBa0IsVUFBQyxHQUFZO0lBQ3RELE9BQUEsR0FBRyxJQUFJLElBQUksSUFBSSxPQUFPLEdBQUcsS0FBSyxRQUFRO0FBQXRDLENBQXNDLENBQUM7QUFFekM7O0dBRUc7QUFDVSxRQUFBLFFBQVEsR0FBa0IsVUFBQyxHQUFZO0lBQ2xELE9BQUEsR0FBRyxJQUFJLElBQUksSUFBSSxPQUFPLEdBQUcsS0FBSyxRQUFRLElBQUksQ0FBQyxDQUFDLEdBQUcsWUFBWSxLQUFLLENBQUM7QUFBakUsQ0FBaUUsQ0FBQztBQUVwRTs7R0FFRztBQUNVLFFBQUEsS0FBSyxHQUNoQixVQUFDLEdBQVksSUFBc0IsT0FBQSxHQUFHLElBQUksSUFBSSxFQUFYLENBQVcsQ0FBQztBQUVqRDs7Ozs7Ozs7O0dBU0c7QUFDVSxRQUFBLEtBQUssR0FBdUIsVUFBQyxFQUFXLElBQW9CLE9BQUEsSUFBSSxFQUFKLENBQUksQ0FBQztBQUU5RTs7OztHQUlHO0FBQ1UsUUFBQSxTQUFTLEdBQUcsYUFBSyxDQUFDO0FBRS9COztHQUVHO0FBQ1UsUUFBQSxPQUFPLEdBQUcsVUFBQyxDQUFRO0lBQzlCLE1BQU0sS0FBSyxDQUFDLDRDQUEwQyxDQUFHLENBQUMsQ0FBQztBQUM3RCxDQUFDLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJpbWl0aXZlcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9wcmltaXRpdmVzLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7O0FBSUEsSUFBTSxtQkFBbUIsR0FBRyxDQUFDLENBQUM7QUFFOUI7O0dBRUc7QUFDVSxRQUFBLFFBQVEsR0FBc0IsVUFBQyxDQUFDO0lBQzNDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUSxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUM7QUFBekMsQ0FBeUMsQ0FBQztBQUU1Qzs7R0FFRztBQUNVLFFBQUEsY0FBYyxHQUFzQixVQUFDLENBQUM7SUFDakQsT0FBQSxPQUFPLENBQUMsS0FBSyxRQUFRLElBQUksQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLENBQUMsQ0FBQyxJQUFJLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO0FBQS9ELENBQStELENBQUM7QUFFbEU7Ozs7O0dBS0c7QUFDVSxRQUFBLE9BQU8sR0FBc0IsVUFBQyxDQUFDO0lBQzFDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUTtBQUFyQixDQUFxQixDQUFDO0FBRXhCOzs7O0dBSUc7QUFDVSxRQUFBLFFBQVEsR0FBRyxlQUFPLENBQUM7QUFFaEM7O0dBRUc7QUFDVSxRQUFBLFVBQVUsR0FBc0IsVUFBQyxDQUFDO0lBQzdDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUSxJQUFJLENBQUMsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxRQUFRLENBQUMsQ0FBQyxDQUFDO0FBQWhFLENBQWdFLENBQUM7QUFFbkU7O0dBRUc7QUFDVSxRQUFBLEtBQUssR0FBc0IsVUFBQyxDQUFDO0lBQ3hDLE9BQUEsT0FBTyxDQUFDLEtBQUssUUFBUSxJQUFJLE1BQU0sQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFDO0FBQXhDLENBQXdDLENBQUM7QUFFM0M7O0dBRUc7QUFDVSxRQUFBLFdBQVcsR0FDdEIsQ0FBQztJQUFJLFlBQVU7U0FBVixVQUFVLEVBQVYscUJBQVUsRUFBVixJQUFVO1FBQVYsdUJBQVU7O0lBQW1CLE9BQUEsVUFBQyxDQUFDLElBQWEsT0FBQSxFQUFFLENBQUMsT0FBTyxDQUFDLENBQU0sQ0FBQyxJQUFJLG1CQUFtQixFQUF6QyxDQUF5QztBQUF4RCxDQUF3RCxDQUd6RixDQUFDO0FBRUo7O0dBRUc7QUFDVSxRQUFBLGlCQUFpQixHQUFHLFVBQW1CLENBQUksSUFBbUIsT0FBQSxVQUFDLENBQUM7SUFDM0UsT0FBQSxDQUFDLEtBQUssQ0FBQztBQUFQLENBQU8sRUFEa0UsQ0FDbEUsQ0FBQztBQUVWOztHQUVHO0FBQ1UsUUFBQSxzQkFBc0IsR0FDakMsQ0FBQztJQUFtQixZQUFVO1NBQVYsVUFBVSxFQUFWLHFCQUFVLEVBQVYsSUFBVTtRQUFWLHVCQUFVOztJQUFtQixPQUFBLFVBQUMsQ0FBQyxJQUFhLE9BQUEsRUFBRSxDQUFDLE9BQU8sQ0FBQyxDQUFNLENBQUMsSUFBSSxtQkFBbUIsRUFBekMsQ0FBeUM7QUFBeEQsQ0FBd0QsQ0FHeEcsQ0FBQztBQUVKOztHQUVHO0FBQ1UsUUFBQSxRQUFRLEdBQXNCLFVBQUMsQ0FBQztJQUMzQyxPQUFBLE9BQU8sQ0FBQyxLQUFLLFFBQVE7QUFBckIsQ0FBcUIsQ0FBQztBQUV4Qjs7R0FFRztBQUNVLFFBQUEsaUJBQWlCLEdBQUcsVUFBbUIsQ0FBSSxJQUFtQixPQUFBLFVBQUMsQ0FBQztJQUMzRSxPQUFBLENBQUMsS0FBSyxDQUFDO0FBQVAsQ0FBTyxFQURrRSxDQUNsRSxDQUFDO0FBRVY7O0dBRUc7QUFDVSxRQUFBLHNCQUFzQixHQUNqQyxDQUFDO0lBQW1CLFlBQVU7U0FBVixVQUFVLEVBQVYscUJBQVUsRUFBVixJQUFVO1FBQVYsdUJBQVU7O0lBQW1CLE9BQUEsVUFBQyxDQUFDLElBQWEsT0FBQSxFQUFFLENBQUMsT0FBTyxDQUFDLENBQU0sQ0FBQyxJQUFJLG1CQUFtQixFQUF6QyxDQUF5QztBQUF4RCxDQUF3RCxDQUd4RyxDQUFDO0FBRUo7O0dBRUc7QUFDVSxRQUFBLFNBQVMsR0FBdUIsVUFBQyxDQUFDO0lBQzdDLE9BQUEsT0FBTyxDQUFDLEtBQUssU0FBUztBQUF0QixDQUFzQixDQUFDO0FBRXpCOztHQUVHO0FBQ1UsUUFBQSxNQUFNLEdBQW9CLFVBQUMsQ0FBQztJQUN2QyxPQUFBLENBQUMsS0FBSyxJQUFJO0FBQVYsQ0FBVSxDQUFDO0FBRWI7O0dBRUc7QUFDVSxRQUFBLFdBQVcsR0FBeUIsVUFBQyxDQUFDO0lBQ2pELE9BQUEsT0FBTyxDQUFDLEtBQUssV0FBVztBQUF4QixDQUF3QixDQUFDO0FBRTNCOztHQUVHO0FBQ1UsUUFBQSxVQUFVLEdBQUcsVUFBSSxHQUFpQjtJQUM3QyxPQUFBLFVBQUMsQ0FBQyxJQUF5QixPQUFBLE9BQU8sQ0FBQyxLQUFLLFdBQVcsSUFBSSxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQWxDLENBQWtDO0FBQTdELENBQTZELENBQUM7QUFFaEU7O0dBRUc7QUFDVSxRQUFBLFVBQVUsR0FBRyxVQUFJLEdBQWlCO0lBQzdDLE9BQUEsVUFBQyxDQUFDLElBQW9CLE9BQUEsQ0FBQyxLQUFLLElBQUksSUFBSSxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQXBCLENBQW9CO0FBQTFDLENBQTBDLENBQUM7QUFFN0M7O0dBRUc7QUFDVSxRQUFBLFNBQVMsR0FBRyxVQUFJLEdBQWlCO0lBQzVDLE9BQUEsVUFBQyxDQUFDLElBQWdDLE9BQUEsQ0FBQyxJQUFJLElBQUksSUFBSSxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQW5CLENBQW1CO0FBQXJELENBQXFELENBQUM7QUFFeEQ7O0dBRUc7QUFDVSxRQUFBLE9BQU8sR0FDbEIsVUFBSSxVQUF3QixJQUFxQixPQUFBLFVBQUMsR0FBWTtJQUM1RCxPQUFBLEtBQUssQ0FBQyxPQUFPLENBQUMsR0FBRyxDQUFDLElBQUksR0FBRyxDQUFDLE1BQU0sQ0FBVSxVQUFDLEdBQUcsRUFBRSxDQUFDLElBQUssT0FBQSxHQUFHLElBQUksVUFBVSxDQUFDLENBQVksQ0FBQyxFQUEvQixDQUErQixFQUFFLElBQUksQ0FBQztBQUE1RixDQUE0RixFQUQ3QyxDQUM2QyxDQUFDO0FBRWpHOztHQUVHO0FBQ1UsUUFBQSxXQUFXLEdBQ3RCLFVBQWlCLEVBQTBCO0lBQ3pDLE9BQUEsVUFBQyxFQUFPLElBQWdCLE9BQUEsRUFBRSxDQUFDLE1BQU0sQ0FBVSxVQUFDLEdBQUcsRUFBRSxDQUFDLElBQUssT0FBQSxHQUFHLElBQUksRUFBRSxDQUFDLENBQUMsQ0FBQyxFQUFaLENBQVksRUFBRSxJQUFJLENBQUMsRUFBbEQsQ0FBa0Q7QUFBMUUsQ0FBMEUsQ0FBQztBQUUvRTs7Ozs7R0FLRztBQUNVLFFBQUEsWUFBWSxHQUFrQixVQUFDLEdBQVk7SUFDdEQsT0FBQSxHQUFHLElBQUksSUFBSSxJQUFJLE9BQU8sR0FBRyxLQUFLLFFBQVE7QUFBdEMsQ0FBc0MsQ0FBQztBQUV6Qzs7R0FFRztBQUNVLFFBQUEsUUFBUSxHQUFrQixVQUFDLEdBQVk7SUFDbEQsT0FBQSxHQUFHLElBQUksSUFBSSxJQUFJLE9BQU8sR0FBRyxLQUFLLFFBQVEsSUFBSSxDQUFDLENBQUMsR0FBRyxZQUFZLEtBQUssQ0FBQztBQUFqRSxDQUFpRSxDQUFDO0FBRXBFOztHQUVHO0FBQ1UsUUFBQSxLQUFLLEdBQ2hCLFVBQWMsR0FBTSxJQUF1QyxPQUFBLEdBQUcsSUFBSSxJQUFJLEVBQVgsQ0FBVyxDQUFDO0FBRXpFOzs7Ozs7Ozs7R0FTRztBQUNVLFFBQUEsS0FBSyxHQUF1QixVQUFDLEVBQVcsSUFBb0IsT0FBQSxJQUFJLEVBQUosQ0FBSSxDQUFDLENBQUMsMkRBQTJEO0FBRTFJOzs7O0dBSUc7QUFDVSxRQUFBLFNBQVMsR0FBRyxhQUFLLENBQUM7QUFFL0I7O0dBRUc7QUFDVSxRQUFBLE9BQU8sR0FBRyxVQUFDLENBQVE7SUFDOUIsTUFBTSxLQUFLLENBQUMsNENBQTBDLENBQUcsQ0FBQyxDQUFDO0FBQzdELENBQUMsQ0FBQyJ9

package.json

 {
   "name": "generic-type-guard",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Generic type guards for TypeScript",
@@ -8,12 +8,12 @@ "main": "dist/index.js",
   "scripts": {
-    "build": "rm -fr dist && tsc --target es3",
-    "prepack": "rm -fr dist && tsc --target es3",
+    "build": "rimraf dist && tsc --target es3",
+    "prepack": "rimraf dist && tsc --target es3",
     "test": "yarn lint && yarn mocha",
     "test-watch": "nodemon -e ts,json --exec yarn test",
-    "lint": "tslint -p . -c ../../tslint.json",
-    "lint-watch": "nodemon -e ts,json --exec tslint -p . -c ../../tslint.json",
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "lint-watch": "nodemon -e ts,json --exec eslint . --ext .js,.jsx,.ts,.tsx",
     "mocha": "nyc mocha --opts mocha.opts",
     "mocha-watch": "nodemon -e ts,json --exec yarn mocha --opts ../../mocha.opts",
-    "stryker": "stryker run ./stryker.conf.js",
-    "stryker-watch": "nodemon -e ts,json --exec stryker run ./stryker.conf.js",
+    "stryker": "stryker run",
+    "stryker-watch": "nodemon -e ts,json --exec stryker run",
     "codecov-local": "nyc report",
@@ -66,22 +66,24 @@ "codecov-report": "nyc report --reporter=json && codecov -p ../.. -f coverage/*.json -F generic_type_guard"
   "devDependencies": {
-    "@stryker-mutator/core": "~1.1.0",
-    "@stryker-mutator/html-reporter": "~1.1.0",
-    "@stryker-mutator/mocha-framework": "~1.1.0",
-    "@stryker-mutator/mocha-runner": "~1.1.0",
-    "@stryker-mutator/typescript": "~1.1.0",
-    "@types/chai": "*",
-    "@types/mocha": "*",
-    "@types/node": "*",
-    "chai": "^4.1.2",
-    "codecov": "^3.0.0",
-    "mocha": "^6.0.2",
-    "nodemon": "^1.18.7",
-    "nyc": "^13.1.0",
-    "source-map-support": "~0.5.3",
-    "ts-node": "^8.0.2",
-    "tslint": "^5.9.1",
-    "tslint-eslint-rules": "^5.0.0",
-    "typescript": "~3.3.3"
+    "@mscharley/eslint-config": "1.2.2",
+    "@stryker-mutator/core": "3.1.0",
+    "@stryker-mutator/mocha-framework": "3.1.0",
+    "@stryker-mutator/mocha-runner": "3.1.0",
+    "@stryker-mutator/typescript": "3.1.0",
+    "@types/chai": "4.2.11",
+    "@types/mocha": "7.0.2",
+    "@types/node": "12.12.36",
+    "@typescript-eslint/eslint-plugin": "2.29.0",
+    "@typescript-eslint/parser": "2.29.0",
+    "chai": "4.2.0",
+    "codecov": "3.6.5",
+    "eslint": "6.8.0",
+    "mocha": "7.1.1",
+    "nodemon": "2.0.3",
+    "nyc": "15.0.1",
+    "rimraf": "3.0.2",
+    "source-map-support": "0.5.17",
+    "ts-node": "8.8.2",
+    "typescript": "3.8.3"
   },
-  "gitHead": "a2002df59aa73f4a305f297b143f9ad7af1d1db9"
+  "gitHead": "bde99cf5ed138de8ecff928caf271065246835bf"
 }

README.md

@@ -6,9 +6,8 @@ # generic-type-guard
 [![Codecov](https://img.shields.io/codecov/c/github/mscharley/generic-type-guard.svg)](https://codecov.io/gh/mscharley/generic-type-guard)
-[![Join the chat at https://gitter.im/generic-type-guard/Lobby](https://badges.gitter.im/generic-type-guard/Lobby.svg)](https://gitter.im/generic-type-guard/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-**Source:** [https://github.com/mscharley/generic-type-guard](https://github.com/mscharley/generic-type-guard/packages/generic-type-guard)  
+**Source:** [https://github.com/mscharley/generic-type-guard](https://github.com/mscharley/generic-type-guard/tree/master/packages/generic-type-guard)  
 **Author:** Matthew Scharley  
 **Contributors:** [See contributors on GitHub][gh-contrib]  
 **Bugs/Support:** [Github Issues][gh-issues]  
-**Copyright:** 2017  
+**Copyright:** 2020  
 **License:** [MIT license][license]  
@@ -76,41 +75,14 @@ **Status:** Active
 
-```typescript 
+```typescript
 import * as tg from "generic-type-guard";
 
-export interface TestInterface {
-  str: string;
-  num: number;
-}
-
-const isTypeSafeTestInterface: tg.PartialTypeGuard<{}, TestInterface> =
-  tg.isIntersection(tg.hasProperty("str", tg.isString), tg.hasProperty("num", tg.isNumber));
-
-export const isTestInterface: TypeGuard<TestInterface> = (o: any): o is TestInterface =>
-  isObject(o) && isTypeSafeTestInterface(o);
-
-// or perhaps you have a larger interface...
-
-export interface ComplexInterface extends TestInterface {
-  b: boolean;
-  maybeString?: string;
-  nullableString: string | null;
-}
-
-export const isTypeSafeComplexInterface: tg.TypeGuard<ComplexInterface> =
-  new tg.IsInterface()
-    .withProperty("str", tg.isString)
-    .withProperty("num", tg.isNumber)
-    .withProperty("b", tg.isBoolean)
-    .withProperty("maybeString", tg.isOptional(tg.isString))
-    .withProperty("nullableString", tg.isNullable(tg.isString))
-    .get();
-
-// Alternatively:
-
-export const isTypeSafeComplexInterface2: tg.PartialTypeGuard<{}, ComplexInterface> =
-  new tg.IntersectionOf(tg.hasProperty("str", tg.isString))
-    .with(tg.hasProperty("num", tg.isNumber))
-    .with(tg.hasProperty("b", tg.isBoolean))
-    .with(tg.hasProperty("maybeString", tg.isUnion(tg.isUndefined, tg.isString)))
-    .with(tg.hasProperty("nullableString", tg.isNullable(tg.isString))).get();
+export const isComplexInterface =
+  new tg.IsInterface().withProperties({
+    str: tg.isString,
+    num: tg.isNumber,
+    b: tg.isBoolean,
+    maybeString: tg.isOptional(tg.isString),
+    nullableString: tg.isNullable(tg.isString),
+  }).get();
+export type ComplexInterface = tg.GuardedType<typeof isComplexInterface>;
 ```
@@ -154,2 +126,11 @@
 
+##### Fix for structural typing issues
+
+If possible, you should reframe the question. Instead of creating a type to guard against, create a guard and export the type:
+
+```typescript
+const isFoo = tg.isRecord("foo", tg.isOptional(tg.isString));
+type Foo = tg.GuardedType<typeof isFoo>;
+```
+
   [gh-contrib]: https://github.com/mscharley/generic-type-guard/graphs/contributors
@@ -156,0 +137,0 @@ [gh-issues]: https://github.com/mscharley/generic-type-guard/issues

No alert changes

Improved metrics

Number of package files

33

increased by6.45%

Lines of code

834

increased by20.17%

Worsened metrics

Total package byte prevSize

48653

decreased by-78.55%

Dev dependency count

20

increased by11.11%

Number of lines in readme file

137

decreased by-12.18%

No dependency changes