@stageus/validator v0.1.3

🚀 @stageus/validator

You can use @stageus/validator to validate different types of data.

@stagues/valdiator allows you to transform or validate not only string type but also various types of data.

Installation

npm install @stageus/validator

✏️ Usage

This library provides validation for Type as well as Boolean, Date, Number, String, Array, NumberArray, and StringArray types.

Firstly, a function called 'message' provides Type validation. Here, you can validate the type and use the basic utility method for validation. Once the type of data to be validated is confirmed, you can define and use the method to validate the type through each type validation method in a chaining manner.

import { message } from '@stageus/validator';

const emailValdiator = message().isString().isEmail();

const result = emailValdiator.run('abc123@xx.xx');
result.valid; // true
result.message; // null
result.value; // abc123@xx.xx

const result2 = emailValidator.run('abc123');
result2.valid; // false
result2.message; // Value is not email format
result2.value; // abc123

Also you can use like below.

const signUpSchema = object({
  email: message('Invalid Email').isString().isEmail()
  pw: message('Invalid Pw').isString().isPw(),
  fileList: array({
    path: message('Invalid file path').isString().length({ min: 1 }),
    ext: message('Invalid file ext').isString().isIn(['png', 'jpeg'])
  })
});
const result3 = signUpSchema.run(userInputData);

Don't forget that you have to call run method in order to execute the chained method.

📄 Document

🔧 Utility

You can use the TypeValidator method through the function named message. The Type validation method can be confirmed through the document below.

message()

You can set an exception message. If it's empty, the default message is output.

message(); // then you can use Type method

message('invalid email').isString().isEmail();

Never forget to call run method.

🔧 Schema

ObjectSchema and ArraySchema can be created through the object function and array function, and the validation schema can be called through the run method to evaluate the value.

object()

It is a funciton of creating an ObjectSchema.

const signUpSchema = object({
  email: message('invalid email').toString().isEmail(),
  pw: message('invalid pw').toString().legnth({ min: 6, max: 12 }).isPw(),
});

const result = signUpSchema.run({ email: 'abc123@xx.xx', pw: '123' });
result.valid; // false
result.value; // { email: "abc123@xx.xx", pw: "123"}
result.reason; // [{ message: "invalid pw", field: "pw" }]

object function returns ObjectSchema.

run(data: any)

Execute validate schema with data.

object({}).run(); // SchemaRunResult

Never forget to call run method.

signUpSchema.run(userInput);

array(any)

It is a funciton of creating an ArraySchema.

Through array function, the value of the object array is validated.

array(signUpSchema);

This function does not support the run method.

To validate, the object function must be used.

array(signUpSchema).run(input);

You can also mix and use functions like below.

const signUpSchema = object({
  email: message('invalid email').isString().isEmail(),
  pw: message('invalid pw').isString().length({ min: 6, max: 12 }),
  info: {
    imgList: array({
      path: message('invalid path').isString().length({ min: 1 }),
      ext: message('invalid ext').isString().isIn(['png', 'jpg']),
    }),
  },
});

Then you can call run method to limit legnth of the array.

signUpSchema.run(data);

length(option)

Also you can use length mehtod.

array(signUpSchema).length({ min: 3 });

🔧 Type Method

🔧 Number Method

🔧 String Method

🔧 Date Method

🔧 Array Method

🔧 Number Array Method

🔧 String Array Method

🔧 Boolean Method

There are no methods yet.

Maintainer

LICENSE

LICENSE