@nodeswork/sbase/koa/validators.d.ts

Basic REST api foundation from Nodeswork.

/// <reference types="validator" />
import { unitOfTime } from 'moment';
import { ParamError, ParamsOptions } from './params';
export declare type Validator = (target: any, path: string | number, val: any, root: any) => boolean | string | ParamError | ParamError[];
export { isArray, isAscii, isBase64, isBoolean, isCreditCard, isDataURI, isEmpty, isFullWidth, isHalfWidth, isHexColor, isHexadecimal, isISIN, isISO31661Alpha2, isISO8601, isISRC, isJSON, isLatLong, isLowercase, isMACAddress, isMD5, isMimeType, isMongoId, isMultibyte, isNumber, isNumeric, isPort, isString, isSurrogatePair, isUppercase, isVariableWidth, required, };
declare const required: Validator;
export declare function contains(seed: string): Validator;
export declare function equals(comparison: string): Validator;
export declare function isAfter(date?: string): Validator;
export declare function isAlpha(locale?: ValidatorJS.AlphaLocale): Validator;
export declare function isAlphanumeric(locale?: ValidatorJS.AlphaLocale): Validator;
declare const isAscii: Validator;
declare const isBase64: Validator;
export declare function isBefore(date?: string): Validator;
declare const isBoolean: Validator;
export declare function isByteLength(min: number, max?: number): Validator;
export declare function isByteLength(options: ValidatorJS.IsByteLengthOptions): Validator;
declare const isCreditCard: Validator;
export declare function isCurrency(options?: ValidatorJS.IsCurrencyOptions): Validator;
declare const isDataURI: Validator;
export declare function isDecimal(options?: ValidatorJS.IsDecimalOptions): Validator;
export declare function isDivisibleBy(number: number): Validator;
export declare function isEmail(options?: ValidatorJS.IsEmailOptions): Validator;
declare const isEmpty: Validator;
export declare function isEnum(enumObject?: object, from?: 'value' | 'key'): Validator;
export declare function isFQDN(options?: ValidatorJS.IsFQDNOptions): Validator;
export declare function isFloat(options?: ValidatorJS.IsFloatOptions): Validator;
declare const isFullWidth: Validator;
declare const isHalfWidth: Validator;
export declare function isHash(algorithm: ValidatorJS.HashAlgorithm): Validator;
declare const isHexColor: Validator;
declare const isHexadecimal: Validator;
export declare function isIP(version?: number): Validator;
export declare function isISSN(options?: ValidatorJS.IsISSNOptions): Validator;
declare const isISIN: Validator;
declare const isISO8601: Validator;
declare const isISO31661Alpha2: Validator;
declare const isISRC: Validator;
export declare function isIn(values: any[]): Validator;
export declare function isInt(options?: ValidatorJS.IsIntOptions): Validator;
declare const isJSON: Validator;
declare const isLatLong: Validator;
export declare function isLength(min: number, max?: number): Validator;
export declare function isLength(options: ValidatorJS.IsLengthOptions): Validator;
declare const isString: Validator;
declare const isArray: Validator;
declare const isNumber: Validator;
declare const isLowercase: Validator;
declare const isMACAddress: Validator;
declare const isMD5: Validator;
declare const isMimeType: Validator;
export declare function isInRange(min: number, max?: number): Validator;
export declare function isMobilePhone(locale: ValidatorJS.MobilePhoneLocale, options?: ValidatorJS.IsMobilePhoneOptions): Validator;
declare const isMongoId: Validator;
declare const isMultibyte: Validator;
declare const isNumeric: Validator;
declare const isPort: Validator;
export declare function isPostalCode(locale: ValidatorJS.PostalCodeLocale): Validator;
declare const isSurrogatePair: Validator;
export declare function isURL(options?: ValidatorJS.IsURLOptions): Validator;
export declare function isUUID(version?: 3 | 4 | 5 | '3' | '4' | '5' | 'all'): Validator;
declare const isUppercase: Validator;
declare const isVariableWidth: Validator;
export declare function isWhitelisted(chars: string | string[]): Validator;
export declare function matches(pattern: RegExp | string, modifiers?: string): Validator;
export declare function isStartOf(unit: unitOfTime.StartOf, tz?: string): Validator;
export declare function isEndOf(unit: unitOfTime.StartOf, tz?: string): Validator;
export declare function blacklist(chars: string): Validator;
export declare function escape(target: any, path: string, val: any): boolean;
export declare function unescape(target: any, path: string, val: any): boolean;
export declare function ltrim(chars?: string): Validator;
export declare function normalizeEmail(options?: ValidatorJS.NormalizeEmailOptions): Validator;
export declare function rtrim(chars?: string): Validator;
export declare function stripLow(keep_new_lines?: boolean): Validator;
export declare function toJSON(): Validator;
export declare function toBoolean(strict?: boolean): Validator;
export declare function toDate(target: any, path: string, val: any): boolean;
export declare function toSeconds(): Validator;
export declare function toFloat(target: any, path: string, val: any): boolean;
export declare function toInt(radix?: number): Validator;
export declare function trim(chars?: string): Validator;
export declare function whitelist(chars?: string): Validator;
export declare function split(separator?: string, restricted?: boolean): Validator;
export declare function withDefault(option: any, includeEmptyString?: boolean): Validator;
/**
 * String.replace
 *
 * @param matcher
 * @param replacer
 */
export declare function replace(matcher: any, replacer: any): Validator;
export declare function extractId(field?: string): Validator;
export declare function toNull(target: any, path: string, val: any): boolean;
export declare function map(fn: (val: any, root: any) => any): Validator;
export declare function array(options: ParamsOptions | Validator | Validator[]): Validator;