@nhtio/validation 0.1.0-master-ebe86e9e → 0.1.0-master-cd50e735

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nhtio/validation",
-  "version": "0.1.0-master-ebe86e9e",
+  "version": "0.1.0-master-cd50e735",
   "description": "A powerful schema description language and data validator",
   "keywords": [],
   "author": "Jak Giveon <jak@nht.io>",

package/private/index.d.ts

@@ -1,3 +1,4 @@
+import type { DateTime } from 'luxon';
 import type { PhoneSchema } from './schemas/phone';
 import type { BigIntSchema } from './schemas/bigint';
 import type { DatetimeSchema } from './schemas/datetime';
@@ -24,21 +25,66 @@ import type { AlternativesSchema, AnySchema, StringSchema, BinarySchema, NumberS
  * @public
  */
 export interface ValidationRoot extends Omit<Root, 'any' | 'string' | 'binary' | 'number' | 'boolean' | 'object' | 'array' | 'date' | 'alternatives' | 'alt'> {
-    any: () => AnySchema;
-    string: () => StringSchema;
-    binary: () => BinarySchema;
-    number: () => NumberSchema;
-    boolean: () => BooleanSchema;
+    /**
+     * Generates a schema object that matches any data type.
+     */
+    any<TSchema = any>(): AnySchema<TSchema>;
+    /**
+     * Generates a schema object that matches an array data type.
+     */
+    array<TSchema = any[]>(): ArraySchema<TSchema>;
+    /**
+     * Generates a schema object that matches a boolean data type (as well as the strings 'true', 'false', 'yes', and 'no'). Can also be called via boolean().
+     */
+    bool<TSchema = boolean>(): BooleanSchema<TSchema>;
+    /**
+     * Generates a schema object that matches a boolean data type (as well as the strings 'true', 'false', 'yes', and 'no'). Can also be called via bool().
+     */
+    boolean<TSchema = boolean>(): BooleanSchema<TSchema>;
+    /**
+     * Generates a schema object that matches a Buffer data type (as well as the strings which will be converted to Buffers).
+     */
+    binary<TSchema = Buffer>(): BinarySchema<TSchema>;
+    /**
+     * Generates a schema object that matches a date type (as well as a JavaScript date string or number of milliseconds).
+     */
+    date<TSchema = Date>(): DateSchema<TSchema>;
+    /**
+     * Generates a schema object that matches a number data type (as well as strings that can be converted to numbers).
+     */
+    number<TSchema = number>(): NumberSchema<TSchema>;
+    /**
+     * Generates a schema object that matches an object data type (as well as JSON strings that have been parsed into objects).
+     */
     object<TSchema = any, IsStrict = false, T = TSchema>(schema?: SchemaMap<T, IsStrict>): ObjectSchema<TSchema>;
-    array: () => ArraySchema;
-    date: () => DateSchema;
-    bigint(): BigIntSchema;
-    datetime(): DatetimeSchema;
-    phone(country?: CountryOrUnknown | Reference | null): PhoneSchema;
+    /**
+     * Generates a schema object that matches a string data type. Note that empty strings are not allowed by default and must be enabled with allow('').
+     */
+    string<TSchema = string>(): StringSchema<TSchema>;
+    /**
+     * Generates a type that will match one of the provided alternative schemas
+     */
     alternatives<TSchema = any>(types: SchemaLike[]): AlternativesSchema<TSchema>;
     alternatives<TSchema = any>(...types: SchemaLike[]): AlternativesSchema<TSchema>;
+    /**
+     * Alias for `alternatives`
+     */
     alt<TSchema = any>(types: SchemaLike[]): AlternativesSchema<TSchema>;
     alt<TSchema = any>(...types: SchemaLike[]): AlternativesSchema<TSchema>;
+    /**
+     * Generates a schema object that matches a BigInt data type.
+     */
+    bigint<TSchema = bigint>(): BigIntSchema<TSchema>;
+    /**
+     * Generates a schema object that matches a DateTime data type.
+     */
+    datetime<TSchema = DateTime>(): DatetimeSchema<TSchema>;
+    /**
+     * Generates a schema object that matches a phone number data type.
+     *
+     * @param country - Optional country code or reference for phone validation
+     */
+    phone<TSchema = string>(country?: CountryOrUnknown | Reference | null): PhoneSchema<TSchema>;
 }
 /**
  * Extended Joi instance with custom schema types.