katalonne / common

MayaJS common modules

MayaJS common modules

Installation

npm i @mayajs/common

Functions

Decorators

• GET
• POST
• PATCH
• DELETE

Validations

• Check
  • isNumber
  • isBoolean
  • isString
  • isAddress
  • isRegExp
  • isDate
  • isEmail
  • isPassword
  • minLength
  • maxLength
  • notEmpty
  • required

DECORATORS

GET

This is a decorator function is for creating a GET METHOD ROUTE. GET request is used to retreive data from a server at the specified resource.

Import

import { Get } from "@mayajs/common";

Usage

@Get({ path: "/", middlewares: [] })
function(){
    // Do some GET stuff here
}

POST

This is a decorator function is for creating a POST METHOD ROUTE. POST requests are used to send data to the API sever to create or udpate a resource. The data sent to the server is stored in the request body of the HTTP request.

Import

import { Post } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [] })
function(){
    // Do some POST stuff here
}

PATCH

This is a decorator function is for creating a PATCH METHOD ROUTE. is similar to POST and PUT but used only apply partial modifications to the resource.

Import

import { Patch } from "@mayajs/common";

Usage

@Patch({ path: "/", middlewares: [] })
function(){
    // Do some PATCH stuff here
}

DELETE

This is a decorator function is for creating a DELETE METHOD ROUTE. DELETE request is used to delete the resource at the specified URL.

Import

import { Delete } from "@mayajs/common";

Usage

@Delete({ path: "/", middlewares: [] })
function(){
    // Do some DELETE stuff here
}

VALIDATIONS

Check

This is a function used for validating fields for BODY and PARAMS of a request.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("age") // Name of the fields to be checked. `defaults` to check the `body` of the request.
     .isNumber() // Checks if the field is a number
     .minLength(5) // Checks if the field has a minimum length of 5
     .maxLength(10) // Checks if the field has a maximum length of 10
     .notEmpty() // Checks if the field is not empty
     .required(), // Checks if the field is present or not undefined
] })
function(){}

isNumber

This is a validation function that is used along with Check. This function checks if the field is a number and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("age").isNumber(),
] })
function(){}

isBoolean

This is a validation function that is used along with Check. This function checks if the field is a boolean and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("islogin").isBoolean(),
] })
function(){}

isString

This is a validation function that is used along with Check. This function checks if the field is a string and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("password").isString(),
] })
function(){}

isAddress

This is a validation function that is used along with Check. This function checks if the field is a valid address and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("address").isAddress(),
] })
function(){}

isRegExp

This is a validation function that is used along with Check. This function accepts a RegExp and checks if the field will match the regex. If the test fails it will send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("password").isRegExp(/^[A-Za-z0-9.,\s]*$/),
] })
function(){}

minLength

This is a validation function that is used along with Check. This function accepts an argument which is a number and checks if the field length is greater than or equal to the parameter. If the field length is not greater than or equal to the parameter it will send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("password").minLength(5),
] })
function(){}

maxLength

This is a validation function that is used along with Check. This function accepts an argument which is a number and checks if the field length is less than or equal to the parameter. If the field length is not less than or equal to the parameter it will send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("password").maxLength(10),
] })
function(){}

isDate

This is a validation function that is used along with Check. This function checks if the field is a valid date and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("date").isDate(),
] })
function(){}

isEmail

This is a validation function that is used along with Check. This function checks if the field is a valid email and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("email").isEmail(),
] })
function(){}

isPassword

This is a validation function that is used along with Check. This function checks if the field is a valid password and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("password").isPassword(),
] })
function(){}

notEmpty

This is a validation function that is used along with Check. This function checks if the field is not empty and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("password").notEmpty(),
] })
function(){}

required

This is a validation function that is used along with Check. This function checks if the field is not undefined and send a validation error response if its not.

Import

import { Check } from "@mayajs/common";

Usage

@Post({ path: "/", middlewares: [
     Check("user").required(),
] })
function(){}