feat: Add string validators and TValidate

README.md

@@ -20,27 +20,31 @@ yarn add tguard
 ## Example Usage
 
 ```ts
-import { Guard, TString, TArray, GuardedType } from "tguard";
+import { Guard, TString, TArray, TStringUUID, GuardedType } from "tguard";
 
 // 1. Here you have some TypeScript types in your program:
 interface User {
+  id: string;
   name: string;
   posts: Array<Post>;
 }
 
 interface Post {
+  id: string;
   title: string;
   body: string;
 }
 
 // 2. Unfortunatelly these types are only exist in TypeScript world.
 // So let's represent those types as type guards:
 const TPost = new Guard({
+  id: TStringUUID(4);
   title: TString,
   body: TString,
 });
 
 const TUser = new Guard({
+  id: TStringUUID(4);
   name: TString,
   posts: TArray(TPost),
 });
@@ -59,18 +63,15 @@ const john: any = {
 
 // 4. Validate if John is a valid 'User' type or not:
 if (TUser.isValid(john)) {
-  // TypeScript will infer John's type as 'User' in this block
-  // So this line won't throw any type errors:
-  const questions = john.posts.filter((post) => post.title.endsWith("?"));
+  // TypeScript will infer John's type as 'User' in this block.
 }
 
 // 5. Or try to cast a value to the User type:
 try {
   const user = TUser.cast({ posts: ["Who am I?", "I am a user."] });
-  // typeof user == User
+  // Type of user is User
 } catch (error) {
-  error.message ===
-    'Validation failed: Missing value at "name", expected type: string'; // true
+  // error.message === 'Validation failed: Missing value at "name", expected type: string'
 }
 ```
 
@@ -189,7 +190,7 @@ new Guard({
 
 ## Schema
 
-`Schema` can be a single [Validator](#validators), a [Validator](#validators)'s constructor,
+`Schema` can be a single [Validator](#validators),
 a Guard, or an object of these types.
 
 ```ts
@@ -275,7 +276,7 @@ try {
 
 ## Validators
 
-Validators are classes that have an `isValid` method, and a name property, which represents the name of the guarded type.
+Validators are instances of `Validator` that have an `isValid` method, and a `name` property, which represents the name of the guarded type.
 
 > Note that this means that Guards are Validators as well. This means you can reuse them in other guard schemas.
 
@@ -405,49 +406,17 @@ Accepts a value when it was **not** accepted by the given validator.
 
 ## Custom Validators
 
-You can define any custom [validator](#validators) or [compound validator](#compound-validators) until
-call signatures are matching.
+You can define any custom [validator](#validators) or [compound validator](#compound-validators) with the `TValidator` compound validator.
 
 ### Examples
 
-Defining an email validator:
+Defining a validator that validates if a number is bigger than 10:
 
 ```ts
-import { Validator } from "tguard";
-
-class TEmail extends Validator<string> {
-  readonly name = "email";
-
-  isValid(value: any): value is string {
-    return typeof value === string && value.includes("@");
-  }
-}
-```
+import { TValidate } from "tguard";
 
-Implementation of the built-in `TArray` [compound validator](#compound-validators):
-
-```ts
-import {
-  Validator,
-  ValidatorOrConstructor,
-  GenericValidator,
-  Guard,
-} from "tguard";
-
-export function TArray<T>(
-  validator: ValidatorOrConstructor<T>
-): Validator<Array<T>> {
-  const guard = new Guard(validator);
-  const name = `${guard.name}[]`;
-
-  function isValid(value: any): value is Array<T> {
-    if (!Array.isArray(value)) return false;
-    for (const item of value) {
-      if (!guard.isValid(item)) return false;
-    }
-    return true;
-  }
-
-  return new GenericValidator(name, isValid);
-}
+const TBiggerThan10 = TValidate(
+  "number(bigger than 10)",
+  (value) => typeof value === "number" && value > 10
+);
 ```

__tests__/index.test.ts

@@ -1,48 +1,4 @@
-import {
-  Guard,
-  TArray,
-  TNumber,
-  TString,
-  TAny,
-  TBigInt,
-  TBoolean,
-  TFunction,
-  TNull,
-  TObject,
-  TUndefined,
-  TObjectOfShape,
-  TOr,
-  TAnd,
-  TNot,
-  TMatch,
-  TNumberAsString,
-  GenericValidator,
-  ValidationError,
-} from "../src";
-
-describe("Exports", () => {
-  it("exported all names", () => {
-    expect(Guard).toBeDefined();
-    expect(TArray).toBeDefined();
-    expect(TNumber).toBeDefined();
-    expect(TNumberAsString).toBeDefined();
-    expect(TString).toBeDefined();
-    expect(TAny).toBeDefined();
-    expect(TBigInt).toBeDefined();
-    expect(TBoolean).toBeDefined();
-    expect(TFunction).toBeDefined();
-    expect(TNull).toBeDefined();
-    expect(TObject).toBeDefined();
-    expect(TUndefined).toBeDefined();
-    expect(TObjectOfShape).toBeDefined();
-    expect(TOr).toBeDefined();
-    expect(TAnd).toBeDefined();
-    expect(TNot).toBeDefined();
-    expect(TMatch).toBeDefined();
-    expect(GenericValidator).toBeDefined();
-    expect(ValidationError).toBeDefined();
-  });
-});
+import { Guard, TArray, TNumber, TString } from "../src";
 
 describe("Example", () => {
   const TPost = new Guard({