class FormData

Supported only in the v8 engine. Introduced in Max v9.2.0.

A multipart/form-data field set.

Index

Constructors

Methods

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;
NameTypeDescription
namestring
valuestring | Blob
optional filenamestring

delete(name)

Removes a field.

delete(name: string): void;
NameTypeDescription
namestring

entries()

Iterates [name, value] pairs.

entries(): IterableIterator<[string, string | Blob]>;
NameTypeDescription
Return ValueIterableIterator<[string, string | Blob]>

forEach(callback)

Invokes a callback for each field.

forEach(
  callback: (value: string | Blob, name: string, parent: FormData) => void,
): void;
NameTypeDescription
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;
NameTypeDescription
namestring
Return Valuestring | Blob | null

getAll(name)

Returns all values for a field.

getAll(name: string): Array<string | Blob>;
NameTypeDescription
namestring
Return ValueArray<string | Blob>

has(name)

Returns whether a field is present.

has(name: string): boolean;
NameTypeDescription
namestring
Return Valueboolean

keys()

Iterates field names.

keys(): IterableIterator<string>;
NameTypeDescription
Return ValueIterableIterator<string>

set(name, value, filename)

Sets a field, replacing existing values.

set(name: string, value: string | Blob, filename?: string): void;
NameTypeDescription
namestring
valuestring | Blob
optional filenamestring

values()

Iterates field values.

values(): IterableIterator<string | Blob>;
NameTypeDescription
Return ValueIterableIterator<string | Blob>