README.md

formstate-x

formstate-x

Index

Enumerations

• ValidateStatus

Classes

• Disposable
• FieldState
• FormState

Interfaces

• ComposibleValidatable
• Disposer
• InputBindings
• Validatable
• Validator
• ValueArrayOf

Type aliases

• FieldsArray
• FieldsObject
• ValidatableFields
• Validated
• ValidationResponse
• ValidatorResponse
• ValueOf
• ValueOfArrayFields
• ValueOfFieldState
• ValueOfFields
• ValueOfObjectFields

Functions

• bindInput

Type aliases

FieldsArray

Ƭ FieldsArray: ComposibleValidatable‹any›[]

Defined in formState.ts:9

Mode: array

---

FieldsObject

Ƭ FieldsObject: object

Defined in formState.ts:7

Mode: object

Type declaration:

• [ key: string]: ComposibleValidatable‹any›

---

ValidatableFields

Ƭ ValidatableFields: FieldsObject | FieldsArray

Defined in formState.ts:11

Each key of the object is a validatable

---

Validated

Ƭ Validated: object

Defined in types.ts:16

Type declaration:

---

ValidationResponse

Ƭ ValidationResponse: string | null | undefined | false

Defined in types.ts:5

A truthy string or falsy values.

---

ValidatorResponse

Ƭ ValidatorResponse: ValidationResponse | Promise‹ValidationResponse›

Defined in types.ts:12

The return value of a validator.

---

ValueOf

Ƭ ValueOf: State extends FormState<infer Fields, infer Fields extends { [key: string]: ComposibleValidatable<any, any>; } ? ValueOfObjectFields : infer Fields extends (infer Field)[] ? ValueArrayOf : never> ? Fields extends { ...; } ? ValueOfObjectFields<...> : Fields extends (infer Field)[] ? ValueArrayOf...

Defined in types.ts:90

Value of state (FormState or FieldState)

---

ValueOfArrayFields

Ƭ ValueOfArrayFields: Fields extends (infer Field)[] ? ValueArrayOf : never

Defined in types.ts:76

Value of array-fields.

---

ValueOfFieldState

Ƭ ValueOfFieldState: State extends FieldState ? FieldType : never

Defined in types.ts:59

Value of FieldState.

---

ValueOfFields

Ƭ ValueOfFields: Fields extends { [key: string]: ComposibleValidatable<any, any>; } ? ValueOfObjectFields : Fields extends (infer Field)[] ? ValueArrayOf : never

Defined in types.ts:83

Value of fields.

---

ValueOfObjectFields

Ƭ ValueOfObjectFields: object

Defined in types.ts:71

Value of object-fields.

Type declaration:

Functions

bindInput

▸ bindInput<T>(state: FieldState‹T›): InputBindings‹T›

Defined in bind.ts:16

Helper method to bind state to your input component. You can define your own bindInput by specifying getValue.

Type parameters:

▪ T

Parameters:

Name	Type
state	FieldState‹T›

Returns: InputBindings‹T›

▸ bindInput<T, E>(state: FieldState‹T›, getValue: function): InputBindings‹T, E›

Defined in bind.ts:17

Type parameters:

▪ T

▪ E

Parameters:

▪ state: FieldState‹T›

▪ getValue: function

▸ (e: E): T

Parameters:

Name	Type
e	E

Returns: InputBindings‹T, E›