Form

Form

A Form object as defined in the JSON schema

Constructor

new Form(props)

Instantiates a new Form

Parameters:
Name Type Description
props object

Properties to initialize the Form with

Properties
Name Type Attributes Default Description
body Array.<FormItem>

Sets Form#body
method 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'HEAD' | 'OPTIONS' | 'TRACE' 'POST'

Sets Form#method
path string

Sets Form#path
header string <optional>

Sets Form#header
footer string <optional>

Sets Form#footer
meta FormMeta <optional>

Sets Form#meta
Source:

Members

body :Array.<FormItem>

This is the Form's body

Source:

This is the Form's footer. It is inherited by those FormItems which don't define a footer.

Source:

This is the Form's generic header. It is used in those FormItems which don't define a header.

Source:

meta :FormMeta

This is the Form's meta. It contains the form configuration

Source:

method :string

This is the Form's method

Default Value:
  • "POST"
Source:

path :string

This is the Form's path

Source:

(readonly) type :string

This is the Form's type

Default Value:
  • "form"
Source:

Methods

(static) fromTag(formTag) → {Form}

Creates a Form from a FormTag

Parameters:
Name Type Description
formTag FormTag
Source: