Skip to content

Commit

Permalink
Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ivandotv @github-actions
ivandotv authored and github-actions[bot] committed Apr 20, 2022
1 parent a5ded83 commit d78f5e4
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 55 deletions.
22 changes: 11 additions & 11 deletions docs/api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ const schema = {

#### Defined in

[field-factory.ts:21](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field-factory.ts#L21)
[field-factory.ts:21](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field-factory.ts#L21)

___

Expand All @@ -99,7 +99,7 @@ Result of the [Field](classes/Field.md) validation

#### Defined in

[field.ts:10](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L10)
[field.ts:10](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L10)

___

Expand All @@ -116,7 +116,7 @@ ___

#### Defined in

[form.ts:36](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/form.ts#L36)
[form.ts:36](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/form.ts#L36)

___

Expand All @@ -135,7 +135,7 @@ Result of running all [Validations](classes/Validation.md)

#### Defined in

[runner.ts:7](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/runner.ts#L7)
[runner.ts:7](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/runner.ts#L7)

___

Expand All @@ -153,7 +153,7 @@ Schema structure with validation results for the fields in the schema

#### Defined in

[form.ts:28](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/form.ts#L28)
[form.ts:28](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/form.ts#L28)

___

Expand All @@ -171,7 +171,7 @@ Schema structure with values for the fields in the schema

#### Defined in

[form.ts:17](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/form.ts#L17)
[form.ts:17](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/form.ts#L17)

___

Expand Down Expand Up @@ -199,7 +199,7 @@ Validation function signature

#### Defined in

[validation.ts:8](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/validation.ts#L8)
[validation.ts:8](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/validation.ts#L8)

## Variables

Expand All @@ -211,7 +211,7 @@ Response string that is returned when the form fails validation

#### Defined in

[form.ts:12](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/form.ts#L12)
[form.ts:12](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/form.ts#L12)

## Functions

Expand Down Expand Up @@ -241,7 +241,7 @@ instance of [Field](classes/Field.md)

#### Defined in

[field-factory.ts:68](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field-factory.ts#L68)
[field-factory.ts:68](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field-factory.ts#L68)

___

Expand All @@ -262,7 +262,7 @@ ___

#### Defined in

[validation.ts:14](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/validation.ts#L14)
[validation.ts:14](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/validation.ts#L14)

___

Expand Down Expand Up @@ -290,4 +290,4 @@ Gets the form [Form](classes/Form.md) from the passed in field

#### Defined in

[utils.ts:24](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/utils.ts#L24)
[utils.ts:24](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/utils.ts#L24)
44 changes: 22 additions & 22 deletions docs/api/classes/Field.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Creates an instance of field.

#### Defined in

[field.ts:95](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L95)
[field.ts:95](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L95)

## Properties

Expand All @@ -95,7 +95,7 @@ Fields that depend on this field

#### Defined in

[field.ts:84](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L84)
[field.ts:84](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L84)

___

Expand Down Expand Up @@ -125,7 +125,7 @@ Errors from the validation process

#### Defined in

[field.ts:48](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L48)
[field.ts:48](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L48)

___

Expand All @@ -137,7 +137,7 @@ Refrence to the [Form](Form.md) that is holding the field instance

#### Defined in

[field.ts:53](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L53)
[field.ts:53](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L53)

___

Expand All @@ -149,7 +149,7 @@ Initial value of field. Field will be reverted to this value after [Field.reset]

#### Defined in

[field.ts:68](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L68)
[field.ts:68](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L68)

___

Expand All @@ -168,7 +168,7 @@ have run at least once

#### Defined in

[field.ts:43](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L43)
[field.ts:43](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L43)

___

Expand All @@ -180,7 +180,7 @@ Determines whether field is in the process of validating

#### Defined in

[field.ts:37](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L37)
[field.ts:37](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L37)

___

Expand All @@ -192,7 +192,7 @@ Name of field

#### Defined in

[field.ts:58](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L58)
[field.ts:58](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L58)

___

Expand All @@ -219,7 +219,7 @@ This method can also be hooked to the HTML "onBlur" event.

#### Defined in

[field.ts:74](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L74)
[field.ts:74](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L74)

___

Expand Down Expand Up @@ -252,7 +252,7 @@ Path of field in the [Form](Form.md) that holds the field

#### Defined in

[field.ts:63](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L63)
[field.ts:63](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L63)

___

Expand Down Expand Up @@ -292,7 +292,7 @@ ID of debounced onChange event

#### Defined in

[field.ts:79](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L79)
[field.ts:79](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L79)

___

Expand All @@ -314,7 +314,7 @@ Gets all the dependant fields

#### Defined in

[field.ts:235](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L235)
[field.ts:235](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L235)

___

Expand All @@ -331,7 +331,7 @@ Field is dirty when current value is not equal to the initial value

#### Defined in

[field.ts:316](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L316)
[field.ts:316](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L316)

___

Expand All @@ -347,7 +347,7 @@ Gets whether field is valid. Field is valid when there are no errors.

#### Defined in

[field.ts:308](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L308)
[field.ts:308](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L308)

## Methods

Expand All @@ -369,7 +369,7 @@ Checks if value is null

#### Defined in

[field.ts:338](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L338)
[field.ts:338](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L338)

___

Expand All @@ -385,7 +385,7 @@ Clears all field errors

#### Defined in

[field.ts:283](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L283)
[field.ts:283](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L283)

___

Expand All @@ -405,7 +405,7 @@ ___

#### Defined in

[field.ts:208](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L208)
[field.ts:208](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L208)

___

Expand All @@ -422,7 +422,7 @@ on all dependant fields.

#### Defined in

[field.ts:324](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L324)
[field.ts:324](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L324)

___

Expand All @@ -443,7 +443,7 @@ ___

#### Defined in

[field.ts:216](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L216)
[field.ts:216](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L216)

___

Expand All @@ -466,7 +466,7 @@ Sets value to the field

#### Defined in

[field.ts:248](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L248)
[field.ts:248](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L248)

___

Expand All @@ -488,7 +488,7 @@ Run all validations for the field

#### Defined in

[field.ts:275](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L275)
[field.ts:275](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L275)

___

Expand All @@ -506,4 +506,4 @@ results of all validations

#### Defined in

[field.ts:190](https://github.com/ivandotv/dumba/blob/d0bf704/packages/dumba/src/field.ts#L190)
[field.ts:190](https://github.com/ivandotv/dumba/blob/a5ded83/packages/dumba/src/field.ts#L190)
Loading

0 comments on commit d78f5e4

Please sign in to comment.