vtils
Version:
一个面向业务的 JavaScript/TypeScript 实用程序库。
111 lines (110 loc) • 4.53 kB
TypeScript
import { ArraySchema } from './array';
import { BooleanSchema } from './boolean';
import { DateSchema } from './date';
import { LocaleValue, MixedLocale } from './Locale';
import { NumberSchema } from './number';
import { ObjectSchema } from './object';
import { Refable } from './ref';
import { StringSchema } from './string';
import { ValidationError } from './ValidationError';
export interface SchemaDescription {
type: string;
label: string;
meta: {};
tests: Array<{
name: string;
params: {};
}>;
}
export interface SchemaValidateOptions {
strict?: boolean;
abortEarly?: boolean;
stripUnknown?: boolean;
recursive?: boolean;
context?: {};
}
export interface SchemaTestOptions<TSchema, TValue, TParams extends {} = {}> {
name: string;
message: LocaleValue<TParams>;
test: (this: {
path: string;
schema: TSchema;
options: SchemaValidateOptions;
parent: any;
createError: (options: {
path: string;
message: LocaleValue;
params?: TParams;
}) => ValidationError;
}, value: TValue) => boolean | Promise<boolean>;
params?: TParams;
exclusive?: boolean;
}
export interface MixedSchema<T = any> {
__isYupSchema__: true;
type: 'mixed' | 'string' | 'number' | 'boolean' | 'object' | 'date' | 'array';
clone(): this;
label(label: string): this;
meta(meta: {}): this;
describe(): SchemaDescription;
/** @类型不友好 */
concat(schema: MixedSchema<any>): this;
validate(value: T, options?: SchemaValidateOptions): Promise<T>;
validateSync(value: T, options?: SchemaValidateOptions): T;
/**
* 验证增强，包括：对象顺序验证、返回结果包含错误信息。
*/
validatePlus(value: T, options?: SchemaValidateOptions): Promise<{
error?: ValidationError;
data: T;
}>;
/**
* 验证增强，包括：对象顺序验证、返回结果包含错误信息。
*/
validatePlusSync(value: T, options?: SchemaValidateOptions): {
error?: ValidationError;
data: T;
};
/** @类型不友好 */
validateAt(path: string, value: any, options?: SchemaValidateOptions): Promise<any>;
/** @类型不友好 */
validateSyncAt(path: string, value: any, options?: SchemaValidateOptions): any;
isValid(value: T, options?: SchemaValidateOptions): Promise<boolean>;
isValidSync(value: T, options?: SchemaValidateOptions): boolean;
cast(value: T, options?: SchemaValidateOptions): any;
isType(value: T): boolean;
strict(isStrict?: boolean): this;
strip(stripField?: boolean): this;
withMutation<X>(fn: (schema: this) => X): X;
default(value: T | (() => T)): this;
default(): T | undefined;
nullable(isNullable?: boolean): this;
allowEmptyString(): this;
required(message?: MixedLocale['required']): this;
notRequired(): this;
defined(): this;
typeError(message: LocaleValue): this;
oneOf(arrayOfValues: Record<any, T> | Refable<T>[], message?: MixedLocale['oneOf']): this;
/** oneOf 的别名 */
enum(arrayOfValues: Record<any, T> | Refable<T>[], message?: MixedLocale['oneOf']): this;
/** oneOf 的别名 */
equals(arrayOfValues: Record<any, T> | Refable<T>[], message?: MixedLocale['oneOf']): this;
notOneOf(arrayOfValues: Refable<T>[], message?: MixedLocale['notOneOf']): this;
when(builder: (value: T, schema: this) => this): this;
when<V>(key: string, builder: {
is: boolean | ((value: V) => boolean);
then: GetSchema<T>;
otherwise: GetSchema<T>;
}): this;
when<V>(key: string, builder: (value: V, schema: this) => this): this;
test(test: SchemaTestOptions<this, T>['test'] | RegExp, message?: SchemaTestOptions<this, T>['message']): this;
test<TParams extends {} = {}>(options: SchemaTestOptions<this, T, TParams>): this;
transform(transformer: (this: this, currentValue: T, originalValue: T) => T): this;
}
export type GetSchema<T> = ([
T
] extends [string] ? StringSchema<T> : [T] extends [number] ? NumberSchema<T> : [T] extends [boolean] ? BooleanSchema<T> : [T] extends [Date] ? DateSchema<T> : T extends Array<infer X> ? ArraySchema<X> : T extends {} ? ObjectSchema<T> : MixedSchema<T>) | MixedSchema<T>;
export type GetObjectSchema<T extends {}> = {
[K in keyof T]: GetSchema<T[K]>;
};
export declare function mixed<T = any>(payload?: (schema: MixedSchema<T>) => MixedSchema<T>): MixedSchema<T>;