@webdevep/fm-module-vue v1.2.3

Модуль для фронтэнда на vue, работающий с сервисом файлового менеджера

Ссылка для скачивания данной документации https://modules.dev-webdevep.ru/filemanager-module/VUE.md

Установка npm модуля

Для установки через npm, выполните команду:

npm i @webdevep/fm-module-vue

Работа с модулем

Параметры модуля

• baseUrl - Урл сервера (используется в fetch)
• chunkSize - Размер чанка в килобайтах
• fileDownloadUrl - Ссылка для загрузки файла (без id - "https://server.com/file-manager-service/api/v1/file")

import { FilemanagerModule } from "@webdevep-modules/fm-module-vue";

const filemanager = new FilemanagerModule({
  baseUrl: "https://server.com/file-manager-service/api/v1",
  chunkSize: 1000,
  fileDownloadUrl: "https://server.com/file-manager-service/api/v1/file",
});

Публичные методы модуля

async getList(root)

Аргументы:

• body - object

{
  root: string|null
  ordering: string
  limit: number
  offset: number
}

Возвращаемое значение:

{
  "ok": true,
  "objects": [],
  "total_objects": 0
} 

async getFileInfo(id)

Аргументы:

• id - string

Возвращаемое значение:

{
  "ok": "true",
  "info": "{ <file-info object> }"
}

async createFolder(body)

Аргументы:

• body - object

{
  name: string
  root: string|null
  metadata: JSON
}

Возвращаемое значение:

{
  "ok": "true",
  "name": "<folder name>",
  "folder_id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
}

async setFileMode(body)

Аргументы:

• body - object

{
  id: string
  mode: string ("public"|"private")
}

Возвращаемое значение:

{
  "ok": "true"
}

async createFileLink(body)

Аргументы:

• body - object

{
  id: string
}

Возвращаемое значение:

{
  "ok": "true",
  "link_token": "some-link-token"
}

async shareFile(body)

Аргументы:

• body - object

{
  id: string
  uid: string
}

Возвращаемое значение:

{
  "ok": "true"
}

async unshareFile(body)

Аргументы:

• body - object

{
  id: string
  uid: string
}

Возвращаемое значение:

{
  "ok": "true"
}

async deleteFiles(ids)

Аргументы:

• ids - arraystring

Возвращаемое значение:

{
  "ok": "true"
}

async updateInfo(id, info)

Аргументы:

• id - string
• info - object

{
  name: string
  metadata: string
  mime_type: string
  root: string|null
}

Возвращаемое значение:

{
  "ok": "true"
}

async renameFile(id, name)

Аргументы:

• id - string
• name - string

Возвращаемое значение:

{
  "ok": "true"
}

async moveFile(id, root)

Аргументы:

• id - string
• root - string|null

Возвращаемое значение:

{
  "ok": "true"
}

async updateMetadata(id, metadata)

Аргументы:

• id - string
• metadata - object

Возвращаемое значение:

{
  "ok": "true"
}

async uploadFile({ file, mode = "private", root = null })

Аргументы:

• file - File
• mode - string ("public"|"private")
• root - string|null

Возвращаемое значение:

{
  "ok": "true"
}

downloadFile(id)

Аргументы:

• id - string

Возвращаемое значение: _