Interface PropertyValidationState

public addRule(rule: IRule): PropertyValidationState

Adds a rule to the chain of rules used to validate the property's value.
[fluent]

fluent

Parameters

• rule: IRule

  the rule to add

Returns

PropertyValidationState

public applicable(value: boolean): PropertyValidationState

Parameters

• value: boolean

Returns

PropertyValidationState

public applicable(fn: () => boolean): PropertyValidationState

Parameters

• fn: () => boolean

Returns

PropertyValidationState

public currencyMajor(options?: ValidationOptions): PropertyValidationState

Parameters

• options?: ValidationOptions optional

Returns

PropertyValidationState

public currencyMajorMinor(options?: ValidationOptions): PropertyValidationState

Parameters

• options?: ValidationOptions optional

Returns

PropertyValidationState

public date(): PropertyValidationState

Returns

PropertyValidationState

public during(earliest: Date, latest: Date, options?: ValidationOptions): PropertyValidationState

Parameters

• earliest: Date

• latest: Date

• options?: ValidationOptions optional

Returns

PropertyValidationState

public during(earliest: () => Date, latest: Date, options?: ValidationOptions): PropertyValidationState

Parameters

• earliest: () => Date

• latest: Date

• options?: ValidationOptions optional

Returns

PropertyValidationState

public during(earliest: Date, latest: () => Date, options?: ValidationOptions): PropertyValidationState

Parameters

• earliest: Date

• latest: () => Date

• options?: ValidationOptions optional

Returns

PropertyValidationState

public during(earliest: () => Date, latest: () => Date, options?: ValidationOptions): PropertyValidationState

Parameters

• earliest: () => Date

• latest: () => Date

• options?: ValidationOptions optional

Returns

PropertyValidationState

public earliest(earliest: Date, options?: ValidationOptions): PropertyValidationState

Parameters

• earliest: Date

• options?: ValidationOptions optional

Returns

PropertyValidationState

public earliest(earliest: () => Date, options?: ValidationOptions): PropertyValidationState

Parameters

• earliest: () => Date

• options?: ValidationOptions optional

Returns

PropertyValidationState

public email(): PropertyValidationState

Returns

PropertyValidationState

public end(): T in Valerie.PropertyValidationState<T>

Returns

T in Valerie.PropertyValidationState<T>

public entryFormat(format: string): PropertyValidationState

Parameters

• format: string

Returns

PropertyValidationState

public excludeFromSummary(): PropertyValidationState

Returns

PropertyValidationState

public expression(regularExpression: RegExp, options?: ValidationOptions): PropertyValidationState

Parameters

• regularExpression: RegExp

• options?: ValidationOptions optional

Returns

PropertyValidationState

public expression(regularExpressionString: string, options?: ValidationOptions): PropertyValidationState

Parameters

• regularExpressionString: string

• options?: ValidationOptions optional

Returns

PropertyValidationState

public failed(): boolean

Returns

boolean

public float(options?: ValidationOptions): PropertyValidationState

Parameters

• options?: ValidationOptions optional

Returns

PropertyValidationState

public getName(): string

Returns

string

public integer(options?: ValidationOptions): PropertyValidationState

Parameters

• options?: ValidationOptions optional

Returns

PropertyValidationState

public isApplicable(): boolean

Returns

boolean

public isRequired(): boolean

Returns

boolean

public latest(latestValueOrFunction: Date, options?: ValidationOptions): PropertyValidationState

Parameters

• latestValueOrFunction: Date

• options?: ValidationOptions optional

Returns

PropertyValidationState

public latest(latestValueOrFunction: () => Date, options?: ValidationOptions): PropertyValidationState

Parameters

• latestValueOrFunction: () => Date

• options?: ValidationOptions optional

Returns

PropertyValidationState

public lengthBetween(shortest: number, longest: number, options?: ValidationOptions): PropertyValidationState

Parameters

• shortest: number

• longest: number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public lengthBetween(shortest: number, longest: () => number, options?: ValidationOptions): PropertyValidationState

Parameters

• shortest: number

• longest: () => number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public lengthBetween(shortest: () => number, longest: number, options?: ValidationOptions): PropertyValidationState

Parameters

• shortest: () => number

• longest: number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public lengthBetween(shortest: () => number, longest: () => number, options?: ValidationOptions): PropertyValidationState

Parameters

• shortest: () => number

• longest: () => number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public matches(permitted: any, options?: ValidationOptions): PropertyValidationState

Parameters

• permitted: any

• options?: ValidationOptions optional

Returns

PropertyValidationState

public matches(permitted: () => any, options?: ValidationOptions): PropertyValidationState

Parameters

• permitted: () => any

• options?: ValidationOptions optional

Returns

PropertyValidationState

public maximum(maximum: any, options?: ValidationOptions): PropertyValidationState

Parameters

• maximum: any

• options?: ValidationOptions optional

Returns

PropertyValidationState

public maximum(maximum: () => any, options?: ValidationOptions): PropertyValidationState

Parameters

• maximum: () => any

• options?: ValidationOptions optional

Returns

PropertyValidationState

public maximumLength(longest: number, options?: ValidationOptions): PropertyValidationState

Parameters

• longest: number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public maximumLength(longest: () => number, options?: ValidationOptions): PropertyValidationState

Parameters

• longest: () => number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public maximumNumberOfItems(maximum: number, options?: ValidationOptions): PropertyValidationState

Parameters

• maximum: number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public maximumNumberOfItems(maximum: () => number, options?: ValidationOptions): PropertyValidationState

Parameters

• maximum: () => number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public message(): string

Returns

string

public minimum(minimumValueOrFunction: any, options?: ValidationOptions): PropertyValidationState

Parameters

• minimumValueOrFunction: any

• options?: ValidationOptions optional

Returns

PropertyValidationState

public minimumLength(shortest: number, options?: ValidationOptions): PropertyValidationState

Parameters

• shortest: number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public minimumLength(shortest: () => number, options?: ValidationOptions): PropertyValidationState

Parameters

• shortest: () => number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public minimumNumberOfItems(minimum: number, options?: ValidationOptions): PropertyValidationState

Parameters

• minimum: number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public minimumNumberOfItems(minimum: () => number, options?: ValidationOptions): PropertyValidationState

Parameters

• minimum: () => number

• options?: ValidationOptions optional

Returns

PropertyValidationState

public name(value: string): PropertyValidationState

Parameters

• value: string

Returns

PropertyValidationState

public name(value: () => string): PropertyValidationState

Parameters

• value: () => string

Returns

PropertyValidationState

public noneOf(forbiddenValues: Array<any>, options?: ValidationOptions): PropertyValidationState

Parameters

• forbiddenValues: Array<any>

• options?: ValidationOptions optional

Returns

PropertyValidationState

public noneOf(forbiddenValues: () => any[], options?: ValidationOptions): PropertyValidationState

Parameters

• forbiddenValues: () => any[]

• options?: ValidationOptions optional

Returns

PropertyValidationState

public not(forbiddenValueOrFunction: any, options?: ValidationOptions): PropertyValidationState

Parameters

• forbiddenValueOrFunction: any

• options?: ValidationOptions optional

Returns

PropertyValidationState

public number(): PropertyValidationState

Returns

PropertyValidationState

public numberOfItems(minimumValueOrFunction: any, maximumValueOrFunction: any, options?: ValidationOptions): PropertyValidationState

Parameters

• minimumValueOrFunction: any

• maximumValueOrFunction: any

• options?: ValidationOptions optional

Returns

PropertyValidationState

public oneOf(permittedValues: Array<any>, options?: ValidationOptions): PropertyValidationState

Parameters

• permittedValues: Array<any>

• options?: ValidationOptions optional

Returns

PropertyValidationState

public oneOf(permittedValues: () => any[], options?: ValidationOptions): PropertyValidationState

Parameters

• permittedValues: () => any[]

• options?: ValidationOptions optional

Returns

PropertyValidationState

public passed(): boolean

Returns

boolean

public pending(): boolean

Returns

boolean

public postcode(): PropertyValidationState

Returns

PropertyValidationState

public range(minimumValueOrFunction: any, maximumValueOrFunction: any, options?: ValidationOptions): PropertyValidationState

Parameters

• minimumValueOrFunction: any

• maximumValueOrFunction: any

• options?: ValidationOptions optional

Returns

PropertyValidationState

public required(valueOrFunction?: any): PropertyValidationState

Parameters

• valueOrFunction?: any optional

Returns

PropertyValidationState

public result(): ValidationResult

Returns

ValidationResult

public rule(testFunction: () => any): PropertyValidationState

Parameters

• testFunction: () => any

Returns

PropertyValidationState

public ruleMessage(failureMessageFormat: string): PropertyValidationState

Parameters

• failureMessageFormat: string

Returns

PropertyValidationState

public showMessage(): boolean

Returns

boolean

public string(): PropertyValidationState

Returns

PropertyValidationState

public touched(): boolean

Returns

boolean

public touched(value: boolean): boolean

Parameters

• value: boolean

Returns

boolean

public validateChildProperties(): PropertyValidationState

Returns

PropertyValidationState

public valueFormat(format: string): PropertyValidationState

Parameters

• format: string

Returns

PropertyValidationState