new FormParam(options)
Represents a Form Data parameter, which can exist in request body.
Parameters:
Name | Type | Description |
---|---|---|
options |
FormParam.definition | Pass the initial definition of the form data parameter. |
- Source:
Members
(static) _postman_propertyAllowsMultipleValues :Boolean
Form params can have multiple values, so set this to true.
Type:
- Boolean
- Source:
(static) _postman_propertyIndexKey :String
Declare the list index key, so that property lists of form parameters work correctly
Type:
- String
- Source:
(static) parse
Parse a form data string into an array of objects, where each object contains a key and a value.
- Source:
- To Do:
-
- implement this, not implemented yet.
Methods
toJSON() → {Object}
Convert the form-param to JSON compatible plain object.
- Source:
Returns:
- Type
- Object
toString() → {String}
Converts the FormParameter to a single param string.
- Source:
Returns:
- Type
- String
valueOf() → {*|String}
Returns the value of the form parameter (if any).
- Source:
Returns:
- Type
- * | String
Type Definitions
definition
Properties:
Name | Type | Description |
---|---|---|
key |
String | The name ("key") of the form data parameter. |
value |
String | The value of the parameter. |
- Source: