Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "types"

Index

Interfaces

Type aliases

Type aliases

BasePicked

BasePicked: "render" | "state" | "getModel" | "hasModel" | "setModel" | "validateModel" | "validateModelAt" | "setError" | "removeError" | "clearError" | "getElement" | "getDefault" | "syncDefaults" | "isTouched" | "isDirty" | "unregister" | "fields" | "mounted" | "removeDirty" | "removeTouched" | "hasInit"

Create useFields type returning IUseFields.

CastHandler

CastHandler: <T>(value: any, path?: string, name?: KeyOf<T>) => any

Type declaration

    • <T>(value: any, path?: string, name?: KeyOf<T>): any

    • Type parameters

      Parameters

      • value: any
      • Optional path: string
      • Optional name: KeyOf<T>

      Returns any

ErrorKeys

ErrorKeys<T>: keyof T

Gets top level list of error keys from model.

Type parameters

ErrorMessageModel

ErrorMessageModel<T>: {}

Used for user defined validation, allows returning simple errors as string or array of string. Result for each key then converted to IValidationError array.

Type parameters

Type declaration

ErrorModel

ErrorModel<T>: {}

Using top level model keys creates type with value of IValidationErrors in array.

Type parameters

Type declaration

IUseFields

IUseFields<Fields, T>: {}

Resulting object upon initializing useFields.

Type parameters

  • Fields: string

  • T

Type declaration

InferReturn

InferReturn<F>: F extends (...args: any[]) => infer R ? R : never

Infers the return type of a passed function.

example

type SomeType = <R, H extends (hook: IKomo) => R>(hook: H): InferReturn;

Type parameters

  • F: Function

KeyOf

KeyOf<T>: Extract<keyof T, string>

Extracts key from type as string.

Type parameters

  • T

PromiseErrorModel

PromiseErrorModel<T>: PromiseStrict<T, ErrorModel<T>>

Typed model for Error Model promises.

Type parameters

RegisterElement

RegisterElement<T>: (element: IRegisterElement) => IRegisteredElement<T>

Type which when called returns an React ref of HTMLElement.

Type parameters

Type declaration

RegisterVirtual

RegisterVirtual<T>: (options: Pick<IRegisterOptions<T>, VirtualPicked>) => RegisterElement<T>

Interface for registering an element.

Type parameters

Type declaration

SubmitHandler

SubmitHandler<T>: (model?: T, errors?: ErrorModel<T>, event?: BaseSyntheticEvent) => void

Handler type for form submission.

Type parameters

Type declaration

    • (model?: T, errors?: ErrorModel<T>, event?: BaseSyntheticEvent): void

    • Parameters

      • Optional model: T
      • Optional errors: ErrorModel<T>
      • Optional event: BaseSyntheticEvent

      Returns void

ValidateModelHandler

ValidateModelHandler<T>: (model: T, fields?: Set<IRegisteredElement<T>>, vanities?: string[], ast?: ISchemaAst) => null | undefined | ErrorMessageModel<T> | ErrorModel<T> | PromiseStrict<T, ErrorModel<T> | ErrorMessageModel<T>>

Validation handler function for user defined validationSchema.

Type parameters

Type declaration

ValidationSchema

ValidationSchema<T>: ObjectSchema<T> | ValidateModelHandler<T>

Generic type for either yup ObjectSchema or user defined Validation Schema handler function.

Type parameters

ValueOf

ValueOf<T, K>: T[K]

Extracts value from type using key of type as string.

Type parameters

VirtualPicked

VirtualPicked: "defaultValue" | "defaultChecked" | "required" | "min" | "max" | "minLength" | "maxLength" | "pattern"

Generated using TypeDoc