⚙️ Controllers #

A controller in Filesrocket is a class that is in charge of parsing the requests before invoking the Service. It basically works as an intermediary point for requests. Its responsibilities are the following:

• Interpret multipart/form-data requests.
• Validate extensions, sizes, file numbers and other properties.
• Generate unique filenames.

Currently the controller has 4 methods responsible for handling your files:

🚀 Upload Files #

This example shows how to upload a file through a request of type multipart/form-data

const files = await controller.create(req, {});

Results

[
  {
    "id": "http://domain.com/image.png",
    "name": "image.jpg",
    "ext": ".jpg",
    "url": "http://domain.com/image.png",
    "size": 12345,
    "dir": "",
    "createdAt": "2022-03-08T20:09:07.958Z",
    "updatedAt": "2022-03-08T20:09:07.958Z"
  }
]

This example shows in a simple way how to upload files, later we will address how to condition these actions through validations, etc.

📝 List files #

This example shows how to list files.

const files = await controller.list({});

Results

{
  "items": [
    {
      "id": "http://domain.com/image.png",
      "name": "image.jpg",
      "ext": ".jpg",
      "url": "http://domain.com/image.png",
      "size": 12345,
      "dir": "",
      "createdAt": "2022-03-08T20:09:07.958Z",
      "updatedAt": "2022-03-08T20:09:07.958Z"
    }
  ],
  "total": 1,
  "size": 1,
  "page": 1,
  "next": null,
  "prev": null
}

🗑️ Delete file #

This method is responsible for deleting files from a certain service. In order to delete a file, you have to send the id.

const file = await controller.remove("abc");

Results

{
  "id": "http://domain.com/image.png",
  "name": "image.jpg",
  "ext": ".jpg",
  "url": "http://domain.com/image.png",
  "size": 12345,
  "dir": "",
  "createdAt": "2022-03-08T20:09:07.958Z",
  "updatedAt": "2022-03-08T20:09:07.958Z"
}

✅ Validations #

You can also validate the file by specifying the rules for the extension, number and size files, and Filesrocket will perform the validations.

const files = await controller.create(req, {
  limits: { files: 5 },
  extnames: [".jpg", ".png", ".jpeg"]
});