Class Route

Performs a DELETE request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.delete("/users/admin");
Copy

Performs a DELETE request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const user = foxx.roue("/users/admin");
const res = await user.delete();
Copy

Performs a GET request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.get("/users", { offset: 10, limit: 5 });
Copy

Performs a GET request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.get({ offset: 10, limit: 5 });
Copy

Performs a HEAD request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.head("/users", { offset: 10, limit: 5 });
Copy

Performs a HEAD request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.head({ offset: 10, limit: 5 });
Copy

Performs a PATCH request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.patch("/users/admin", { password: "admin" });
Copy

Performs a PATCH request against the given path relative to this route and returns the server response.

Note: body must not be a string.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const user = foxx.route("/users/admin")
const res = await user.patch({ password: "admin" });
Copy

Performs a POST request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.post("/users", {
  username: "admin",
  password: "hunter2"
});
Copy

Performs a POST request against the given path relative to this route and returns the server response.

Note: body must not be a string.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
const res = await users.post({
  username: "admin",
  password: "hunter2"
});
Copy

Performs a PUT request against the given path relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.put("/users/admin/password", { password: "admin" });
Copy

Performs a PUT request against the given path relative to this route and returns the server response.

Note: body must not be a string.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const password = foxx.route("/users/admin/password");
const res = await password.put({ password: "admin" });
Copy

Performs an arbitrary HTTP request relative to this route and returns the server response.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const res = await foxx.request({
  method: "POST",
  path: "/users",
  body: {
    username: "admin",
    password: "hunter2"
  }
});
Copy

Creates a new route relative to this route that inherits any of its default HTTP headers.

Example

const db = new Database();
const foxx = db.route("/my-foxx-service");
const users = foxx.route("/users");
Copy