Skip to content

Stageus-Corp/express-validator

Repository files navigation

🚀 @stageus/express-validator

You can use @stageus/express-validator to validate body, query and params of Express.Request.

Installation

npm install @stageus/express-validator

✏️ Usage

You can use validate function. This function return RequestHandler.

validate([
  body('email', message('invalid email').isString().isEmail()),
]);
router.post( 
  '/user', 
  validate([
    body({
      email: message('invalid email').isString().isEmail(),
      pw: message('invalid password').isString().length({ min: 6, max: 16}).isPw(),
      profileImg: {
        fileName: message('invalid file name').isString().
        fileExt: message('invalid file extension').isString()
      }
    })
  ]),
  (req, res) => {
    // Do Something...
  }
)

📄 Document

You can check the validation method to be chanined can be confirmed through the following document.

🔧 validate()

Through validate function, a RequestHandler can be created to validate of the body, query, and params properties of the Express.Request.

That is, the validate function validate all Validations of the array of first parameter.

validate([
    body('email', message('invalid email').isString().isEmail()),
    params('page', message('invalid page').isNumber().isInt()),
])

In the above example, the body value and the params value are evaluated simultaneously.

🔧 body()

Through the body function, one Validation can be created to evaluate req.body.

// Evaluate `req.body` as a whole
body({
    email: message('invalid email').isString().isEmail()
});

// Evaluate only `req.body.email` 
body('email', message('invalid email').isString().isEmail());

🔧 query()

Through the query function, one Validation can be created to evaluate req.query.

// Evaluate `req.query` as a whole
query({
    page: message('invalid pagenation').isNumber()
});

// Evaluate only `req.query.page` 
query('page', message('invalid pagenation').isNumber());

🔧 params()

Through the params function, one Validation can be created to evaluate req.params.

// Evaluate `req.params` as a whole
params({
    idx: message('invalid idx').isNumber()
});

// Evaluate only `req.params.idx` 
params('idx', message('invalid idx').isNumber());

Maintainer

Kyeong Chan Min
Kyeong Chan Min

Author

LICENSE

LICENSE