Interface SaveOptions

Options for a save via ajax.

interface SaveOptions {
    data?: any;
    error?: ((e: any, status?: any) => any);
    headers?: Record<string, string>;
    parameters?: Record<string, any>;
    success?: ((r: any) => any);
    type?: string;
    url: string;
}

Hierarchy (view full)

Properties

data? error? headers? parameters? success? type? url

Properties

Optionaldata

data?: any

optional data to save. If not provided we use the return value of exportData().

Optionalerror

error?: ((e: any, status?: any) => any)

Optional callback to execute if there was an error saving the data.

Optionalheaders

headers?: Record<string, string>

Optional headers to set on the ajax request. By default, the Toolkit will send a Content-Type:"application/json" header. If you provide your own headers this header will continue to be sent, unless of course you override it.

Optionalparameters

parameters?: Record<string, any>

Optional parameters to pass to the exporter. If you write a custom exporter you may wish to use this.

Optionalsuccess

success?: ((r: any) => any)

Optional callback to execute once the data has saved successfully.

Optionaltype

type?: string

Specifies the data type in which to format the data. Defaults to "json". This must match the name of an exporter registered with the given instance of the Toolkit.

url

url: string

URL to POST data to. Required.

Settings

Member Visibility

On This Page

Properties
Version :