Skip to content

Fix wrong TypeScript types #65

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 21, 2019
Merged

Fix wrong TypeScript types #65

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 18 additions & 11 deletions index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/** type declaration for fastest-validator */

declare interface ValidationRuleObject {
interface ValidationRuleObject {
type: string;
optional?: boolean;
empty?: boolean;
Expand All @@ -23,39 +23,46 @@ declare interface ValidationRuleObject {
convert?: boolean;
items?: string;
props?: ValidationSchema;
check?: (value: any, schema: ValidationSchema) => boolean | ValidationResult;
check?: (value: any, schema: ValidationSchema) => true | ValidationResult;
}

declare type ValidationRule = ValidationRuleObject | ValidationRuleObject[] | string;
type ValidationRule = ValidationRuleObject | ValidationRuleObject[] | string;

declare interface ValidationSchema {
interface ValidationSchema {
[key: string]: ValidationRule;
}


declare interface ValidationError {
interface ValidationError {
type: string;
field: string;
message: string;
expected?: any;
actual?: any;
}

declare type ValidationResult = ValidationError[];
declare type ValidationObject = { [key: string]: any };
type ValidationResult = ValidationError[];
type ValidationObject = { [key: string]: any };

declare class Validator {
class Validator {
constructor(opts?: any);

add(type: string, fn: any): void;

makeError(type: string, expected: any, actual: any): ValidationResult;

compile(schema: ValidationSchema): (object: ValidationObject) => boolean | ValidationResult;
compile(schema: ValidationSchema | ValidationSchema[]): (object: ValidationObject) => boolean | ValidationResult;

validate(obj: ValidationObject, schema: ValidationSchema): boolean | ValidationResult;
}

declare module "fastest-validator" {
export = Validator;
export {
ValidationRuleObject,
ValidationRule,
ValidationSchema,
ValidationError,
ValidationResult,
ValidationObject,
}

export = Validator