Merge pull request #141 from danludwig/danludwig/work

Add definition file for knockout.validation plugin.
2026-09-09 11:13:57 +08:00 · 2012-12-26 18:07:53 -08:00
parent a48917fc8f 9203b0f50c
commit 4d480212b7
1 changed files with 140 additions and 0 deletions
@@ -0,0 +1,140 @@
+/// <reference path="knockout-2.2.d.ts" />
+
+interface KnockoutValidationGroupingOptions {
+    deep?: bool;
+    observable?: bool;
+}
+
+interface KnockoutValidationConfiguration {
+    registerExtenders?: bool;
+    messagesOnModified?: bool;
+    messageTemplate?: string;
+    insertMessages?: bool;
+    parseInputAttributes?: bool;
+    writeInputAttributes?: bool;
+    decorateElement?: bool;
+    errorClass?: string;
+    errorElementClass?: string;
+    errorMessageClass?: string;
+    grouping?: KnockoutValidationGroupingOptions;
+}
+
+interface KnockoutValidationUtils {
+    isArray(o: any): bool;
+    isObject(o: any): bool;
+    values(o: any): any[];
+    getValue(o: any): any;
+    hasAttribute(node: Element, attr: string): bool;
+    isValidatable(o: any): bool;
+    insertAfter(node: Element, newNode: Element): void;
+    newId(): number;
+    getConfigOptions(element: Element): KnockoutValidationConfiguration;
+    setDomData(node: Element, data: KnockoutValidationConfiguration): void;
+    getDomData(node: Element): KnockoutValidationConfiguration;
+    contextFor(node: Element): KnockoutValidationConfiguration;
+    isEmptyVal(val: any): bool;
+}
+
+interface KnockoutValidationAsyncCallbackArgs {
+    isValid: bool;
+    message: string;
+}
+
+interface KnockoutValidationAsyncCallback {
+    (result: bool): void;
+    (result: KnockoutValidationAsyncCallbackArgs): void;
+}
+
+interface KnockoutValidationRuleDefinition {
+    message: string;
+    validator(value: any, params: any): bool;
+}
+
+interface KnockoutValidationAsyncRuleDefinition extends KnockoutValidationRuleDefinition {
+    async: bool;
+    validator(value: any, params: any, callback: KnockoutValidationAsyncCallback): void;
+}
+
+interface KnockoutValidationAnonymousRuleDefinition {
+    validation: KnockoutValidationRuleDefinition;
+}
+
+interface KnockoutValidationRuleDefinitions {
+    date: KnockoutValidationRuleDefinition;
+    dateISO: KnockoutValidationRuleDefinition;
+    digit: KnockoutValidationRuleDefinition;
+    email: KnockoutValidationRuleDefinition;
+    equal: KnockoutValidationRuleDefinition;
+    max: KnockoutValidationRuleDefinition;
+    maxLength: KnockoutValidationRuleDefinition;
+    min: KnockoutValidationRuleDefinition;
+    minLength: KnockoutValidationRuleDefinition;
+    notEqual: KnockoutValidationRuleDefinition;
+    number: KnockoutValidationRuleDefinition;
+    pattern: KnockoutValidationRuleDefinition;
+    phoneUS: KnockoutValidationRuleDefinition;
+    required: KnockoutValidationRuleDefinition;
+    step: KnockoutValidationRuleDefinition;
+    unique: KnockoutValidationRuleDefinition;
+}
+
+interface KnockoutValidationRule {
+    rule: string;
+    params: any;
+    message?: string;
+    condition?: () => bool;
+}
+
+interface KnockoutValidationErrors {
+    (): string[];
+    showAllMessages(): void;
+    showAllMessages(show: bool): void;
+}
+
+interface KnockoutValidationGroup {
+    errors?: KnockoutValidationErrors;
+    isValid?: () => bool;
+    isAnyMessageShown?: () => bool;
+}
+
+interface KnockoutValidationStatic {
+    init(options?: KnockoutValidationConfiguration, force?: bool): void;
+    configure(options: KnockoutValidationConfiguration): void;
+    reset(): void;
+
+    group(obj: any, options?: any): () => string[];
+
+    formatMessage(message: string, params: string): string;
+
+    addRule(observable: KnockoutObservableAny, rule: KnockoutValidationRule): KnockoutObservableAny;
+    addRule(observable: KnockoutObservableString, rule: KnockoutValidationRule): KnockoutObservableString;
+    addRule(observable: KnockoutObservableNumber, rule: KnockoutValidationRule): KnockoutObservableNumber;
+    addRule(observable: KnockoutObservableBool, rule: KnockoutValidationRule): KnockoutObservableBool;
+    addRule(observable: KnockoutObservableDate, rule: KnockoutValidationRule): KnockoutObservableDate;
+    addAnonymousRule(observable: KnockoutObservableBase, ruleObj: KnockoutValidationAnonymousRuleDefinition): void;
+
+    insertValidationMessage(element: Element): Element;
+    parseInputValidationAttributes(element: Element, valueAccessor: () => KnockoutObservableBase): void;
+
+    rules: KnockoutValidationRuleDefinitions;
+
+    addExtender(ruleName: string): void;
+    registerExtenders(): void;
+    utils: KnockoutValidationUtils;
+
+    localize(msgTranslations: any): void;
+    validateObservable(observable: KnockoutObservableBase): bool;
+}
+
+interface KnockoutStatic {
+    validation: KnockoutValidationStatic;
+    validatedObservable(initialValue: any): KnockoutObservableBase;
+    applyBindingsWithValidation(viewModel: any, rootNode?: any, options?: KnockoutValidationConfiguration): void;
+}
+
+interface KnockoutSubscribableFunctions {
+    isValid: KnockoutComputed;
+    isValidating: KnockoutObservableBool;
+    rules: KnockoutObservableArray;
+}
+