justus 0.5.1 → 0.5.2

package/src/types.ts

@@ -52,7 +52,17 @@ export const defaultValidationOptions: Readonly<Required<ValidationOptions>> = {
 export interface Validator<T = any, I = T> extends Iterable<TupleRestParameter<T, I>> {
   [Symbol.justusValidator]: this
 
-  optional?: boolean
+  /**
+   * A flag indicating whether the type being validated is _optional_ (the input
+   * can be `undefined`) or not (default: `false`).
+   */
+  optional: boolean
+  /**
+   * The _default_ replaced by this `Validator` when the input is `undefined`.
+   *
+   * This is used in conjunction with the `optional` flag.
+   */
+  defaultValue: T | undefined
 
   /** Validate a _value_ and optionally convert it to the required `Type` */
   validate(value: unknown, options?: ValidationOptions | undefined): T
@@ -73,6 +83,7 @@ export function makeValidatorFactory<
 >(validator: V, factory: F): F & V {
   return Object.assign(factory, {
     optional: validator.optional,
+    defaultValue: validator.defaultValue,
     validate: validator.validate.bind(validator),
     [Symbol.iterator]: validator[Symbol.iterator].bind(validator),
     [Symbol.justusValidator]: validator,
@@ -87,7 +98,8 @@ export abstract class AbstractValidator<T, I = T>
 implements Validator<T, I>, Iterable<TupleRestParameter<T, I>> {
   [Symbol.justusValidator] = this
 
-  optional?: boolean = undefined
+  optional: boolean = false
+  defaultValue: T | undefined = undefined
 
   /** Validate a _value_ and optionally convert it to the required `Type` */
   abstract validate(value: unknown, options?: ValidationOptions | undefined): T

package/src/utilities.ts

@@ -1,3 +1,4 @@
+import { assertSchema } from './errors'
 import { registry } from './registry'
 
 import type { Schema, Validation, Validator } from './types'
@@ -6,12 +7,10 @@ import type { Schema, Validation, Validator } from './types'
  * UTILITY FUNCTIONS                                                          *
  * ========================================================================== */
 
-/**
- * Return the `Validator` for the given `Validation`.
- *
- * When `validation` is `undefined` it will return a `Validator<any>`,
- */
+/** Return the `Validator` for the given `Validation` */
 export function getValidator(validation: Validation): Validator {
+  assertSchema(validation !== undefined, 'No validator for undefined validation')
+
   // Null is a constant
   if (validation === null) return new (registry.get('constant'))(null)