@bakku/validation v4.0.2

1 Install & Use

1.1 Install

   npm install @bakku/validation

1.2 Use

Recommended use asyncValidate function for all validation.

Return an error if it is failed the validation, return correct value of data if it passed the validation

Refer: use asyncValidate

asyncValidate = async <T = any>(
  schema?: ISchemaCore<T>,
  data?: T,
  name?: string
): Promise<IValidationError | TypeOptional<T>> => {

1.2.1 asyncValidateString

Return an error if it is failed the validation, return string (as inputted data) if it passed the validation Refer: use asyncValidateString

asyncValidateString = async (
  schema: IStringSchema,
  data?: any,
  name?: string
): Promise<IValidationError | string>

1.2.2 asyncValidateNumber

Return an error if it is failed the validation, return number (as inputted data or converted data) if it passed the validation Refer: use asyncValidateNumber

asyncValidateNumber = async (
  schema: INumberSchema,
  data?: any,
  name?: string
): Promise<IValidationError | number> => {

1.2.3 asyncValidateInteger

Return an error if it is failed the validation, return integer (as inputted data or converted data) if it passed the validation Refer: use asyncValidateInteger

asyncValidateInteger = async (
  schema: IIntegerSchema,
  data?: any,
  name?: string
): Promise<IValidationError | number> => {

1.2.4 asyncValidateFile

Note: file type is Express.Multer.File Return an error if it is failed the validation, return file (as inputted data) if it passed the validation Refer: use asyncValidateFile

asyncValidateFile = async (
  schema: IFileSchema,
  data?: any,
  name?: string
): Promise<IValidationError | Express.Multer.File> => {

1.2.5 asyncValidateDate

Return an error if it is failed the validation, return Date (as inputted data or converted data) if it passed the validation Refer: use asyncValidateDate

Note: we convert to moment data for validation, so the format base on moment rules.

asyncValidateDate = async (
  schema: IDateSchema,
  data?: any,
  name?: string
): Promise<IValidationError | Date> => {

1.2.6 asyncValidateBoolean

Return an error if it is failed the validation, return Boolean (as inputted data or converted data) if it passed the validation Refer: use asyncValidateBoolean

asyncValidateBoolean = async (
  schema: IBooleanSchema,
  data?: any,
  name?: string
): Promise<IValidationError | boolean> => {

1.2.7 asyncValidateEnum

Return an error if it is failed the validation, return Enum Value (as inputted data) if it passed the validation Refer: use asyncValidateEnum

asyncValidateEnum = async (
  schema: IEnumSchema,
  data?: any,
  name?: string
): Promise<IValidationError | any> => {

1.2.8 asyncValidateArray

Return an error if it is failed the validation, return Array (as inputted data with corrected items ) if it passed the validation Refer: use asyncValidateArray

asyncValidateArray = async <T>(
  schema: IArraySchema<T>,
  data?: any,
  name?: string
): Promise<IValidationError | Array<T>> => {

1.2.9 asyncValidateObject

Return an error if it is failed the validation, return Object (as inputted data with corrected properties ) if it passed the validation Refer: use asyncValidateObject

asyncValidateObject = async <T = unknown>(
  schema: IObjectSchema<T>,
  data?: T,
  name?: string
): Promise<IValidationError | TypeOptional<T>> => {

2 Schemas

ISchemaGeneral is a common type, It can be understand as all schema has in the library.

export type ISchemaGeneral =  ISchemaCore | IBooleanSchema | IStringSchema | INumberSchema | IIntegerSchema | IFileSchema | IDateSchema | IEnumSchema | IArraySchema | IObjectSchema;

2.1 ISchemaCore.

Core schema with validation is extends IValidationCore

2.2 IStringSchema.

String schema extend ISchemaCore with validation is IValidationString

2.3 INumberSchema.

Number schema extend ISchemaCore with validation is IValidationNumber

2.4 IIntegerSchema.

Integer schema extend ISchemaCore with validation is IValidationInteger

2.5 IFileSchema.

File schema extend ISchemaCore with validation is IValidationFile

2.6 IDateSchema.

Array schema extend ISchemaCore with validation is IValidationDate with extra properties:

let dateSchema: IDateSchema = {
  type: 'date',
  dateFormat: 'YYYY-MM-DD',
  validation: {...},
};
// **Note: when you use convertToDateMoment, dateFormat will be ignored.**
dateSchema = {
  type: 'date',
  convertToDateMoment: (date) => moment(date, 'YYYY-MM-DD'),
  validation: {...},
};

// convert to local timezone
dateSchema = {
  type: 'date',
  convertToDateMoment: (data: string) => {
    const currentOffset = moment().utcOffset();
    return moment.utc(data, 'YYYY-MM-DD').utcOffset(currentOffset);
  },
  validation: {...},
};

2.6 IEnumSchema.

Enum schema extend ISchemaCore with validation is IValidationEnum with extra properties:

enum TempEnum {
  active = 'active',
  inactive = 'inactive',
  normal = 'normal',
}
const enumSchema: IEnumSchema = {
  type: 'enum',
  enumData: getEnumData(TempEnum),
  enumName: 'TempEnum'
  validation: {...},
};

2.6 IArraySchema.

Array schema extend ISchemaCore with validation is IValidationArray with extra properties:

2.6 IObjectSchema.

Object schema extend ISchemaCore with validation is IValidationObject with extra properties:

#3 . Data

3.1 SchemaType

Types of schema which library support for validation:
'boolean' |'string' |'number' |'integer' |'enum' |'date' |'file' |'array' |'object'

3.2 IValidationCore

NOTE: validation: (data, pathName) => (IValidationError | undefined) | Promise<IValidationError | undefined>

3.3 IValidationString

is extended IValidationCore with extra properties:

3.4 IValidationNumber

is extended IValidationCore with extra properties:

3.5 IValidationInteger

is the same with IValidationNumber

3.6 IValidationFile

is extended IValidationCore with extra properties:

3.7 IValidationDate

is extended IValidationCore with extra properties:

3.8 IValidationEnum

is extended IValidationNumber with no extra properties.

3.9 IValidationArray

is extended IValidationCore with extra properties:

3.10 IValidationObject

is extended IValidationCore with extra properties: