Class StorageRoute

Hierarchy

StorageRoute

Index

Constructors

constructor

Properties

Methods

Object literals

errors

Constructors

constructor

new StorageRoute(storageService: StorageService): StorageRoute

- Defined in lib/routes/storage.route.ts:22
Parameters
- storageService: StorageService
Returns StorageRoute

Properties

disabled

disabled: string[] = ['post', 'put', 'delete']

endpoint

endpoint: string = "/storage"

Methods

delete

delete(req: { body: { id: string }; data: { auth: AuthData } }): void

- Defined in lib/routes/storage.route.ts:113
delete a file

Parameters
- req: { body: { id: string }; data: { auth: AuthData } }
  - body: { id: string }
    - id: string
  - data: { auth: AuthData }
    - auth: AuthData
Returns void

get

get(req: { data: { auth?: AuthData }; query: { id: string } }): FileInfo

- Defined in lib/routes/storage.route.ts:30
Get file information

Parameters
- req: { data: { auth?: AuthData }; query: { id: string } }
  - data: { auth?: AuthData }
    - Optional auth?: AuthData
  - query: { id: string }
    - id: string
Returns FileInfo

post

post(req: { body: { id: string; update: FileUpdateData }; data: { auth: AuthData } }): void

- Defined in lib/routes/storage.route.ts:96
update a file

Parameters
- req: { body: { id: string; update: FileUpdateData }; data: { auth: AuthData } }
  - body: { id: string; update: FileUpdateData }
    - id: string
    - update: FileUpdateData
  - data: { auth: AuthData }
    - auth: AuthData
Returns void

put

put(req: { body: { file?: UploadFile; files?: UploadResource[]; folder?: undefined | string; rename?: RenamePolicy; share?: FileSharing }; data: { auth?: AuthData } }): FileInfo | FileInfo[]

- Defined in lib/routes/storage.route.ts:47
upload a file / multiple files

Parameters
- req: { body: { file?: UploadFile; files?: UploadResource[]; folder?: undefined | string; rename?: RenamePolicy; share?: FileSharing }; data: { auth?: AuthData } }
  - body: { file?: UploadFile; files?: UploadResource[]; folder?: undefined | string; rename?: RenamePolicy; share?: FileSharing }
    - Optional file?: UploadFile
    - Optional files?: UploadResource[]
    - Optional folder?: undefined | string
    - Optional rename?: RenamePolicy
    - Optional share?: FileSharing
  - data: { auth?: AuthData }
    - Optional auth?: AuthData
Returns FileInfo | FileInfo[]

Object literals

errors

errors: object

storage/invalid-size

storage/invalid-size: string = "The file is too big."

storage/invalid-type

storage/invalid-type: string = "The file format is not supported."

storage/invalid-upload

storage/invalid-upload: string = "Invalid upload resource."

storage/no-edit

storage/no-edit: string = "No EDIT permission."

storage/no-file

storage/no-file: string = "File not found (no VIEW permission or trashed)."

Generated using TypeDoc