Class ValidationScope

Constructors

constructor

Properties

addValidatorResult allValidatorsOkay removeValidatorResult validatorResults

Methods

isValid useValidator useZodValidator

Constructors

constructor

Properties

Private addValidatorResult

addValidatorResult: any

Private allValidatorsOkay

allValidatorsOkay: any

Private removeValidatorResult

removeValidatorResult: any

Private validatorResults

validatorResults: any

Methods

isValid

  • isValid(): boolean

  • Returns boolean

useValidator

  • useValidator(validator: Validator): {
        triggerUpdate: (() => void);
        validationResult: Ref<{
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message?: string;
            type: "success";
        } | {
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message: string;
            type: "error";
        } | {
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message: string;
            type: "warning";
        }>;
    }

  • Parameters

    Returns {
        triggerUpdate: (() => void);
        validationResult: Ref<{
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message?: string;
            type: "success";
        } | {
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message: string;
            type: "error";
        } | {
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message: string;
            type: "warning";
        }>;
    }

    • triggerUpdate: (() => void)
        • (): void

        • Returns void

    • validationResult: Ref<{
          actions?: {
              callback: (() => void | PromiseLike<void>);
              label: string;
          }[];
          message?: string;
          type: "success";
      } | {
          actions?: {
              callback: (() => void | PromiseLike<void>);
              label: string;
          }[];
          message: string;
          type: "error";
      } | {
          actions?: {
              callback: (() => void | PromiseLike<void>);
              label: string;
          }[];
          message: string;
          type: "warning";
      }>

useZodValidator

  • useZodValidator<Z extends ZodTypeAny>(schema: Z, getter: (() => TypeOf<Z>), scope?: ValidationScope): {
        triggerUpdate: (() => void);
        validationResult: Ref<{
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message?: string;
            type: "success";
        } | {
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message: string;
            type: "error";
        } | {
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message: string;
            type: "warning";
        }>;
    }

  • Type Parameters

    Parameters

    Returns {
        triggerUpdate: (() => void);
        validationResult: Ref<{
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message?: string;
            type: "success";
        } | {
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message: string;
            type: "error";
        } | {
            actions?: {
                callback: (() => void | PromiseLike<void>);
                label: string;
            }[];
            message: string;
            type: "warning";
        }>;
    }

    • triggerUpdate: (() => void)
        • (): void

        • Returns void

    • validationResult: Ref<{
          actions?: {
              callback: (() => void | PromiseLike<void>);
              label: string;
          }[];
          message?: string;
          type: "success";
      } | {
          actions?: {
              callback: (() => void | PromiseLike<void>);
              label: string;
          }[];
          message: string;
          type: "error";
      } | {
          actions?: {
              callback: (() => void | PromiseLike<void>);
              label: string;
          }[];
          message: string;
          type: "warning";
      }>

Settings

Member Visibility

Theme

On This Page

constructoraddValidatorResultallValidatorsOkayremoveValidatorResultvalidatorResultsisValiduseValidatoruseZodValidator