AdonisJS attachment

This package is currently development and will replace attachment-advanced for AdonisJS 6.

Links

View documentation

ChangeLog

Discord

Project sample : adonis-starter-kit

Roadmap

• attachment file by file system
• attachment file by buffer
• attachment file by path
• attachment file by url
• attachment file by stream
• attachment files
• save meta data
• variantes
  • images
    • blurhash
  • documents thumbnail
  • videos thumbnail
• command regenerate
• command make:convert
• adonis-drive/flydrive
• jobs queue
• serialize

Setup

Install and configure the package:

1node ace add @jrmc/adonis-attachment

Sample

Simple upload file

1// app/models/user.ts
2import { BaseModel } from '@adonisjs/lucid/orm'
3import { compose } from '@adonisjs/core/helpers'
4import { attachment, Attachmentable } from '@jrmc/adonis-attachment'
5import type { Attachment } from '@jrmc/adonis-attachment/types/attachment'
6
7class User extends compose(BaseModel, Attachmentable) {
8  @attachment()
9  declare avatar: Attachment
10}

---

1// app/controllers/users_controller.ts
2import { attachmentManager } from '@jrmc/adonis-attachment'
3
4class UsersController {
5  public store({ request }: HttpContext) {
6    const avatar = request.file('avatar')!
7    const user = new User()
8
9    user.avatar = await attachmentManager.createFromFile(avatar)
10    await user.save()
11  }
12}

---

1<img src="{{ await user.avatar.getUrl() }}" loading="lazy" alt="" />

Read documentation for advanced usage(thumbnail video/pdf/doc, create from buffer/base64...)