DayPilot.Http.delete

The DayPilot.Http.delete() method makes an HTTP request to the specified URL using the DELETE method.

The syntax and behavior is inspired by axios.

It is a static method.

Declaration

DayPilot.Http.delete(url[, options]);

Parameters

  • url (string) - URL of the HTTP request

  • options.headers (object, optional) - an object with header values

Return Value

The DayPilot.Http.delete() method returns a promise. If the HTTP response status code is 200, 201, 204, or 304, the promise is resolved; otherwise it is rejected.

Resolved promise handlers receive an args object with the following properties:

  • args.request - XMLHttpRequest object used for making the request

  • args.data - event data received from the server, converted from JSON to object using JSON.parse()

Rejected promise handlers receive an args object with the following property:

  • args.request - XMLHttpRequest object used for making the request

Example

const id = 1;
const {data: result} = await DayPilot.Http.delete(`/user/${id}`);
console.log("result", result);

See Also

DayPilot.Http Class

Availability

Availability of this API item in DayPilot editions:

LitePro
DayPilot for JavaScript