Interface ValidatorFn
arguments: any;
caller: Function;
length: number;
name: string;
prototype: any;
[hasInstance](value: any): boolean;
apply(this: Function, thisArg: any, argArray?: any): any;
bind(this: Function, thisArg: any, ...argArray: any[]): any;
call(this: Function, thisArg: any, ...argArray: any[]): any;
subscribe?(this: void, run: Subscriber<any>, invalidate?: Invalidator<any>): Unsubscriber;
toString(): string;
(data: ValidationData): TJSPositionData;
}
Hierarchy
- Function
- ValidatorFn
- Validator
Fn (data): TJSPositionData Parameters
- data: ValidationData
Validation data to handle.
Returns TJSPositionData
The validated position data or null to cancel position update.
- data: ValidationData
Methods
[hasInstance]
- [has
Instance] (value): boolean Determines whether the given value inherits from this function if this function was used as a constructor function.
A constructor function can control which objects are recognized as its instances by 'instanceof' by overriding this method.
Parameters
- value: any
Returns boolean
apply
- apply(this, thisArg, argArray?): any
Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.
Parameters
- this: Function
- thisArg: any
The object to be used as the this object.
OptionalargArray: anyA set of arguments to be passed to the function.
Returns any
bind
- bind(this, thisArg, ...argArray): any
For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters.
Parameters
- this: Function
- thisArg: any
An object to which the this keyword can refer inside the new function.
Rest...argArray: any[]A list of arguments to be passed to the new function.
Returns any
call
- call(this, thisArg, ...argArray): any
Calls a method of an object, substituting another object for the current object.
Parameters
- this: Function
- thisArg: any
The object to be used as the current object.
Rest...argArray: any[]A list of arguments to be passed to the method.
Returns any
Optionalsubscribe
- subscribe(this, run, invalidate?): Unsubscriber
Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will be processed again.
Parameters
- this: void
- run: Subscriber<any>
Optionalinvalidate: Invalidator<any>
Returns Unsubscriber
TJSPosition validator function that takes a ValidationData instance potentially modifying
positiondata or returning null if invalid.