@fgv/ts-utils 1.2.0-alpha.2 → 1.3.0

package/validation/validators.d.ts

@@ -1,8 +1,32 @@
 import { FieldValidators, ObjectValidator, ObjectValidatorConstructorParams } from './object';
-import { GenericValidator } from './genericValidator';
+import { BooleanValidator } from './boolean';
 import { NumberValidator } from './number';
 import { StringValidator } from './string';
+/**
+ * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.
+ * @public
+ */
 export declare const string: StringValidator<string, unknown>;
+/**
+ * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.
+ * @public
+ */
 export declare const number: NumberValidator<number, unknown>;
-export declare const boolean: GenericValidator<boolean, undefined>;
+/**
+ * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.
+ * @public
+ */
+export declare const boolean: BooleanValidator<unknown>;
+/**
+ * Helper function to create a {@link Validation.Classes.ObjectValidator | ObjectValidator} which validates
+ * an object in place.
+ * @param fields - A {@link Validation.Classes.FieldValidators | field validator definition}
+ * describing the validations to be applied.
+ * @param params - Optional {@link Validation.Classes.ObjectValidatorConstructorParams | parameters}
+ * to refine the behavior of the resulting {@link Validation.Validator | validator}.
+ * @returns A new {@link Validation.Validator | Validator} which validates the desired
+ * object in place.
+ * @public
+ */
 export declare function object<T, TC>(fields: FieldValidators<T, TC>, params?: Omit<ObjectValidatorConstructorParams<T, TC>, 'fields'>): ObjectValidator<T, TC>;
+//# sourceMappingURL=validators.d.ts.map

package/validation/validators.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validators.d.ts","sourceRoot":"","sources":["../../src/validation/validators.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,gCAAgC,EAAE,MAAM,UAAU,CAAC;AAE9F,OAAO,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAE3C;;;GAGG;AACH,eAAO,MAAM,MAAM,kCAAwB,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,MAAM,kCAAwB,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,OAAO,2BAAyB,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,EAAE,EACxB,MAAM,EAAE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,EAC9B,MAAM,CAAC,EAAE,IAAI,CAAC,gCAAgC,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,QAAQ,CAAC,GACjE,eAAe,CAAC,CAAC,EAAE,EAAE,CAAC,CAExB"}

package/validation/validators.js

@@ -23,19 +23,37 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.object = exports.boolean = exports.number = exports.string = void 0;
 const object_1 = require("./object");
-const genericValidator_1 = require("./genericValidator");
+const boolean_1 = require("./boolean");
 const number_1 = require("./number");
 const string_1 = require("./string");
-const result_1 = require("../result");
+/**
+ * A {@link Validation.Classes.StringValidator | StringValidator} which validates a string in place.
+ * @public
+ */
 exports.string = new string_1.StringValidator();
+/**
+ * A {@link Validation.Classes.NumberValidator | NumberValidator} which validates a number in place.
+ * @public
+ */
 exports.number = new number_1.NumberValidator();
-exports.boolean = new genericValidator_1.GenericValidator({
-    validator: (from) => typeof from === 'boolean'
-        ? true
-        : result_1.fail(`Not a boolean: "${JSON.stringify(from)}"`),
-});
+/**
+ * A {@link Validation.Classes.BooleanValidator | BooleanValidator} which validates a boolean in place.
+ * @public
+ */
+exports.boolean = new boolean_1.BooleanValidator();
+/**
+ * Helper function to create a {@link Validation.Classes.ObjectValidator | ObjectValidator} which validates
+ * an object in place.
+ * @param fields - A {@link Validation.Classes.FieldValidators | field validator definition}
+ * describing the validations to be applied.
+ * @param params - Optional {@link Validation.Classes.ObjectValidatorConstructorParams | parameters}
+ * to refine the behavior of the resulting {@link Validation.Validator | validator}.
+ * @returns A new {@link Validation.Validator | Validator} which validates the desired
+ * object in place.
+ * @public
+ */
 function object(fields, params) {
     return new object_1.ObjectValidator({ fields, ...(params !== null && params !== void 0 ? params : {}) });
 }
 exports.object = object;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy92YWxpZGF0aW9uL3ZhbGlkYXRvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9CRzs7O0FBRUgscUNBQThGO0FBRTlGLHlEQUFzRDtBQUN0RCxxQ0FBMkM7QUFDM0MscUNBQTJDO0FBQzNDLHNDQUFpQztBQUVwQixRQUFBLE1BQU0sR0FBRyxJQUFJLHdCQUFlLEVBQUUsQ0FBQztBQUMvQixRQUFBLE1BQU0sR0FBRyxJQUFJLHdCQUFlLEVBQUUsQ0FBQztBQUMvQixRQUFBLE9BQU8sR0FBRyxJQUFJLG1DQUFnQixDQUFVO0lBQ2pELFNBQVMsRUFBRSxDQUFDLElBQWEsRUFBRSxFQUFFLENBQ3pCLE9BQU8sSUFBSSxLQUFLLFNBQVM7UUFDckIsQ0FBQyxDQUFDLElBQUk7UUFDTixDQUFDLENBQUMsYUFBSSxDQUFDLG1CQUFtQixJQUFJLENBQUMsU0FBUyxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUM7Q0FDN0QsQ0FBQyxDQUFDO0FBRUgsU0FBZ0IsTUFBTSxDQUNsQixNQUE4QixFQUM5QixNQUFnRTtJQUVoRSxPQUFPLElBQUksd0JBQWUsQ0FBQyxFQUFFLE1BQU0sRUFBRSxHQUFHLENBQUMsTUFBTSxhQUFOLE1BQU0sY0FBTixNQUFNLEdBQUksRUFBRSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0FBQzlELENBQUM7QUFMRCx3QkFLQyIsInNvdXJjZXNDb250ZW50IjpbIi8qXG4gKiBDb3B5cmlnaHQgKGMpIDIwMjEgRXJpayBGb3J0dW5lXG4gKlxuICogUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBvZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weVxuICogb2YgdGhpcyBzb2Z0d2FyZSBhbmQgYXNzb2NpYXRlZCBkb2N1bWVudGF0aW9uIGZpbGVzICh0aGUgXCJTb2Z0d2FyZVwiKSwgdG8gZGVhbFxuICogaW4gdGhlIFNvZnR3YXJlIHdpdGhvdXQgcmVzdHJpY3Rpb24sIGluY2x1ZGluZyB3aXRob3V0IGxpbWl0YXRpb24gdGhlIHJpZ2h0c1xuICogdG8gdXNlLCBjb3B5LCBtb2RpZnksIG1lcmdlLCBwdWJsaXNoLCBkaXN0cmlidXRlLCBzdWJsaWNlbnNlLCBhbmQvb3Igc2VsbFxuICogY29waWVzIG9mIHRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25zIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzXG4gKiBmdXJuaXNoZWQgdG8gZG8gc28sIHN1YmplY3QgdG8gdGhlIGZvbGxvd2luZyBjb25kaXRpb25zOlxuICpcbiAqIFRoZSBhYm92ZSBjb3B5cmlnaHQgbm90aWNlIGFuZCB0aGlzIHBlcm1pc3Npb24gbm90aWNlIHNoYWxsIGJlIGluY2x1ZGVkIGluIGFsbFxuICogY29waWVzIG9yIHN1YnN0YW50aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS5cbiAqXG4gKiBUSEUgU09GVFdBUkUgSVMgUFJPVklERUQgXCJBUyBJU1wiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBLSU5ELCBFWFBSRVNTIE9SXG4gKiBJTVBMSUVELCBJTkNMVURJTkcgQlVUIE5PVCBMSU1JVEVEIFRPIFRIRSBXQVJSQU5USUVTIE9GIE1FUkNIQU5UQUJJTElUWSxcbiAqIEZJVE5FU1MgRk9SIEEgUEFSVElDVUxBUiBQVVJQT1NFIEFORCBOT05JTkZSSU5HRU1FTlQuIElOIE5PIEVWRU5UIFNIQUxMIFRIRVxuICogQVVUSE9SUyBPUiBDT1BZUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdFUyBPUiBPVEhFUlxuICogTElBQklMSVRZLCBXSEVUSEVSIElOIEFOIEFDVElPTiBPRiBDT05UUkFDVCwgVE9SVCBPUiBPVEhFUldJU0UsIEFSSVNJTkcgRlJPTSxcbiAqIE9VVCBPRiBPUiBJTiBDT05ORUNUSU9OIFdJVEggVEhFIFNPRlRXQVJFIE9SIFRIRSBVU0UgT1IgT1RIRVIgREVBTElOR1MgSU4gVEhFXG4gKiBTT0ZUV0FSRS5cbiAqL1xuXG5pbXBvcnQgeyBGaWVsZFZhbGlkYXRvcnMsIE9iamVjdFZhbGlkYXRvciwgT2JqZWN0VmFsaWRhdG9yQ29uc3RydWN0b3JQYXJhbXMgfSBmcm9tICcuL29iamVjdCc7XG5cbmltcG9ydCB7IEdlbmVyaWNWYWxpZGF0b3IgfSBmcm9tICcuL2dlbmVyaWNWYWxpZGF0b3InO1xuaW1wb3J0IHsgTnVtYmVyVmFsaWRhdG9yIH0gZnJvbSAnLi9udW1iZXInO1xuaW1wb3J0IHsgU3RyaW5nVmFsaWRhdG9yIH0gZnJvbSAnLi9zdHJpbmcnO1xuaW1wb3J0IHsgZmFpbCB9IGZyb20gJy4uL3Jlc3VsdCc7XG5cbmV4cG9ydCBjb25zdCBzdHJpbmcgPSBuZXcgU3RyaW5nVmFsaWRhdG9yKCk7XG5leHBvcnQgY29uc3QgbnVtYmVyID0gbmV3IE51bWJlclZhbGlkYXRvcigpO1xuZXhwb3J0IGNvbnN0IGJvb2xlYW4gPSBuZXcgR2VuZXJpY1ZhbGlkYXRvcjxib29sZWFuPih7XG4gICAgdmFsaWRhdG9yOiAoZnJvbTogdW5rbm93bikgPT5cbiAgICAgICAgdHlwZW9mIGZyb20gPT09ICdib29sZWFuJ1xuICAgICAgICAgICAgPyB0cnVlXG4gICAgICAgICAgICA6IGZhaWwoYE5vdCBhIGJvb2xlYW46IFwiJHtKU09OLnN0cmluZ2lmeShmcm9tKX1cImApLFxufSk7XG5cbmV4cG9ydCBmdW5jdGlvbiBvYmplY3Q8VCwgVEM+KFxuICAgIGZpZWxkczogRmllbGRWYWxpZGF0b3JzPFQsIFRDPixcbiAgICBwYXJhbXM/OiBPbWl0PE9iamVjdFZhbGlkYXRvckNvbnN0cnVjdG9yUGFyYW1zPFQsIFRDPiwgJ2ZpZWxkcyc+LFxuKTogT2JqZWN0VmFsaWRhdG9yPFQsIFRDPiB7XG4gICAgcmV0dXJuIG5ldyBPYmplY3RWYWxpZGF0b3IoeyBmaWVsZHMsIC4uLihwYXJhbXMgPz8ge30pIH0pO1xufVxuIl19
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoidmFsaWRhdG9ycy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy92YWxpZGF0aW9uL3ZhbGlkYXRvcnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9CRzs7O0FBRUgscUNBQThGO0FBRTlGLHVDQUE2QztBQUM3QyxxQ0FBMkM7QUFDM0MscUNBQTJDO0FBRTNDOzs7R0FHRztBQUNVLFFBQUEsTUFBTSxHQUFHLElBQUksd0JBQWUsRUFBRSxDQUFDO0FBRTVDOzs7R0FHRztBQUNVLFFBQUEsTUFBTSxHQUFHLElBQUksd0JBQWUsRUFBRSxDQUFDO0FBRTVDOzs7R0FHRztBQUNVLFFBQUEsT0FBTyxHQUFHLElBQUksMEJBQWdCLEVBQUUsQ0FBQztBQUU5Qzs7Ozs7Ozs7OztHQVVHO0FBQ0gsU0FBZ0IsTUFBTSxDQUNsQixNQUE4QixFQUM5QixNQUFnRTtJQUVoRSxPQUFPLElBQUksd0JBQWUsQ0FBQyxFQUFFLE1BQU0sRUFBRSxHQUFHLENBQUMsTUFBTSxhQUFOLE1BQU0sY0FBTixNQUFNLEdBQUksRUFBRSxDQUFDLEVBQUUsQ0FBQyxDQUFDO0FBQzlELENBQUM7QUFMRCx3QkFLQyIsInNvdXJjZXNDb250ZW50IjpbIi8qXG4gKiBDb3B5cmlnaHQgKGMpIDIwMjEgRXJpayBGb3J0dW5lXG4gKlxuICogUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBvZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weVxuICogb2YgdGhpcyBzb2Z0d2FyZSBhbmQgYXNzb2NpYXRlZCBkb2N1bWVudGF0aW9uIGZpbGVzICh0aGUgXCJTb2Z0d2FyZVwiKSwgdG8gZGVhbFxuICogaW4gdGhlIFNvZnR3YXJlIHdpdGhvdXQgcmVzdHJpY3Rpb24sIGluY2x1ZGluZyB3aXRob3V0IGxpbWl0YXRpb24gdGhlIHJpZ2h0c1xuICogdG8gdXNlLCBjb3B5LCBtb2RpZnksIG1lcmdlLCBwdWJsaXNoLCBkaXN0cmlidXRlLCBzdWJsaWNlbnNlLCBhbmQvb3Igc2VsbFxuICogY29waWVzIG9mIHRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25zIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzXG4gKiBmdXJuaXNoZWQgdG8gZG8gc28sIHN1YmplY3QgdG8gdGhlIGZvbGxvd2luZyBjb25kaXRpb25zOlxuICpcbiAqIFRoZSBhYm92ZSBjb3B5cmlnaHQgbm90aWNlIGFuZCB0aGlzIHBlcm1pc3Npb24gbm90aWNlIHNoYWxsIGJlIGluY2x1ZGVkIGluIGFsbFxuICogY29waWVzIG9yIHN1YnN0YW50aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS5cbiAqXG4gKiBUSEUgU09GVFdBUkUgSVMgUFJPVklERUQgXCJBUyBJU1wiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBLSU5ELCBFWFBSRVNTIE9SXG4gKiBJTVBMSUVELCBJTkNMVURJTkcgQlVUIE5PVCBMSU1JVEVEIFRPIFRIRSBXQVJSQU5USUVTIE9GIE1FUkNIQU5UQUJJTElUWSxcbiAqIEZJVE5FU1MgRk9SIEEgUEFSVElDVUxBUiBQVVJQT1NFIEFORCBOT05JTkZSSU5HRU1FTlQuIElOIE5PIEVWRU5UIFNIQUxMIFRIRVxuICogQVVUSE9SUyBPUiBDT1BZUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdFUyBPUiBPVEhFUlxuICogTElBQklMSVRZLCBXSEVUSEVSIElOIEFOIEFDVElPTiBPRiBDT05UUkFDVCwgVE9SVCBPUiBPVEhFUldJU0UsIEFSSVNJTkcgRlJPTSxcbiAqIE9VVCBPRiBPUiBJTiBDT05ORUNUSU9OIFdJVEggVEhFIFNPRlRXQVJFIE9SIFRIRSBVU0UgT1IgT1RIRVIgREVBTElOR1MgSU4gVEhFXG4gKiBTT0ZUV0FSRS5cbiAqL1xuXG5pbXBvcnQgeyBGaWVsZFZhbGlkYXRvcnMsIE9iamVjdFZhbGlkYXRvciwgT2JqZWN0VmFsaWRhdG9yQ29uc3RydWN0b3JQYXJhbXMgfSBmcm9tICcuL29iamVjdCc7XG5cbmltcG9ydCB7IEJvb2xlYW5WYWxpZGF0b3IgfSBmcm9tICcuL2Jvb2xlYW4nO1xuaW1wb3J0IHsgTnVtYmVyVmFsaWRhdG9yIH0gZnJvbSAnLi9udW1iZXInO1xuaW1wb3J0IHsgU3RyaW5nVmFsaWRhdG9yIH0gZnJvbSAnLi9zdHJpbmcnO1xuXG4vKipcbiAqIEEge0BsaW5rIFZhbGlkYXRpb24uQ2xhc3Nlcy5TdHJpbmdWYWxpZGF0b3IgfCBTdHJpbmdWYWxpZGF0b3J9IHdoaWNoIHZhbGlkYXRlcyBhIHN0cmluZyBpbiBwbGFjZS5cbiAqIEBwdWJsaWNcbiAqL1xuZXhwb3J0IGNvbnN0IHN0cmluZyA9IG5ldyBTdHJpbmdWYWxpZGF0b3IoKTtcblxuLyoqXG4gKiBBIHtAbGluayBWYWxpZGF0aW9uLkNsYXNzZXMuTnVtYmVyVmFsaWRhdG9yIHwgTnVtYmVyVmFsaWRhdG9yfSB3aGljaCB2YWxpZGF0ZXMgYSBudW1iZXIgaW4gcGxhY2UuXG4gKiBAcHVibGljXG4gKi9cbmV4cG9ydCBjb25zdCBudW1iZXIgPSBuZXcgTnVtYmVyVmFsaWRhdG9yKCk7XG5cbi8qKlxuICogQSB7QGxpbmsgVmFsaWRhdGlvbi5DbGFzc2VzLkJvb2xlYW5WYWxpZGF0b3IgfCBCb29sZWFuVmFsaWRhdG9yfSB3aGljaCB2YWxpZGF0ZXMgYSBib29sZWFuIGluIHBsYWNlLlxuICogQHB1YmxpY1xuICovXG5leHBvcnQgY29uc3QgYm9vbGVhbiA9IG5ldyBCb29sZWFuVmFsaWRhdG9yKCk7XG5cbi8qKlxuICogSGVscGVyIGZ1bmN0aW9uIHRvIGNyZWF0ZSBhIHtAbGluayBWYWxpZGF0aW9uLkNsYXNzZXMuT2JqZWN0VmFsaWRhdG9yIHwgT2JqZWN0VmFsaWRhdG9yfSB3aGljaCB2YWxpZGF0ZXNcbiAqIGFuIG9iamVjdCBpbiBwbGFjZS5cbiAqIEBwYXJhbSBmaWVsZHMgLSBBIHtAbGluayBWYWxpZGF0aW9uLkNsYXNzZXMuRmllbGRWYWxpZGF0b3JzIHwgZmllbGQgdmFsaWRhdG9yIGRlZmluaXRpb259XG4gKiBkZXNjcmliaW5nIHRoZSB2YWxpZGF0aW9ucyB0byBiZSBhcHBsaWVkLlxuICogQHBhcmFtIHBhcmFtcyAtIE9wdGlvbmFsIHtAbGluayBWYWxpZGF0aW9uLkNsYXNzZXMuT2JqZWN0VmFsaWRhdG9yQ29uc3RydWN0b3JQYXJhbXMgfCBwYXJhbWV0ZXJzfVxuICogdG8gcmVmaW5lIHRoZSBiZWhhdmlvciBvZiB0aGUgcmVzdWx0aW5nIHtAbGluayBWYWxpZGF0aW9uLlZhbGlkYXRvciB8IHZhbGlkYXRvcn0uXG4gKiBAcmV0dXJucyBBIG5ldyB7QGxpbmsgVmFsaWRhdGlvbi5WYWxpZGF0b3IgfCBWYWxpZGF0b3J9IHdoaWNoIHZhbGlkYXRlcyB0aGUgZGVzaXJlZFxuICogb2JqZWN0IGluIHBsYWNlLlxuICogQHB1YmxpY1xuICovXG5leHBvcnQgZnVuY3Rpb24gb2JqZWN0PFQsIFRDPihcbiAgICBmaWVsZHM6IEZpZWxkVmFsaWRhdG9yczxULCBUQz4sXG4gICAgcGFyYW1zPzogT21pdDxPYmplY3RWYWxpZGF0b3JDb25zdHJ1Y3RvclBhcmFtczxULCBUQz4sICdmaWVsZHMnPixcbik6IE9iamVjdFZhbGlkYXRvcjxULCBUQz4ge1xuICAgIHJldHVybiBuZXcgT2JqZWN0VmFsaWRhdG9yKHsgZmllbGRzLCAuLi4ocGFyYW1zID8/IHt9KSB9KTtcbn1cbiJdfQ==