class FormData
Supported only in the v8 engine. Introduced in Max v9.2.0.
A multipart/form-data field set.
Index
Constructors
Methods
- append(name, value, filename)
- delete(name)
- entries()
- forEach(callback)
- get(name)
- getAll(name)
- has(name)
- keys()
- set(name, value, filename)
- values()
new FormData()
new FormData();
Constructs a new instance of the FormData class
append(name, value, filename)
Appends a field, optionally with a filename for blob parts.
append(name: string, value: string | Blob, filename?: string): void;
| Name | Type | Description |
|---|---|---|
| name | string | |
| value | string | Blob | |
| optional filename | string |
delete(name)
Removes a field.
delete(name: string): void;
| Name | Type | Description |
|---|---|---|
| name | string |
entries()
Iterates [name, value] pairs.
entries(): IterableIterator<[string, string | Blob]>;
| Name | Type | Description |
|---|---|---|
| Return Value | IterableIterator<[string, string | Blob]> |
forEach(callback)
Invokes a callback for each field.
forEach(
callback: (value: string | Blob, name: string, parent: FormData) => void,
): void;
| Name | Type | Description |
|---|---|---|
| callback | (value: string | Blob, name: string, parent: FormData) => void |
get(name)
Returns the first value for a field, or null.
get(name: string): string | Blob | null;
| Name | Type | Description |
|---|---|---|
| name | string | |
| Return Value | string | Blob | null |
getAll(name)
Returns all values for a field.
getAll(name: string): Array<string | Blob>;
| Name | Type | Description |
|---|---|---|
| name | string | |
| Return Value | Array<string | Blob> |
has(name)
Returns whether a field is present.
has(name: string): boolean;
| Name | Type | Description |
|---|---|---|
| name | string | |
| Return Value | boolean |
keys()
Iterates field names.
keys(): IterableIterator<string>;
| Name | Type | Description |
|---|---|---|
| Return Value | IterableIterator<string> |
set(name, value, filename)
Sets a field, replacing existing values.
set(name: string, value: string | Blob, filename?: string): void;
| Name | Type | Description |
|---|---|---|
| name | string | |
| value | string | Blob | |
| optional filename | string |
values()
Iterates field values.
values(): IterableIterator<string | Blob>;
| Name | Type | Description |
|---|---|---|
| Return Value | IterableIterator<string | Blob> |