itd-api / FilesResource

Interface: FilesResource

Defined in: resources/files.ts:52

Файлы и медиа.

Extends

• BaseResource

Methods

get()

get(fileId, options?): Promise<unknown>;

Defined in: resources/files.ts:99

Загружает сведения о файле.

Для ещё не прикреплённого файла сервер может ответить 404.

Parameters

fileId

string

options?

RequestOptions = {}

Returns

Promise<unknown>

---

remove()

remove(fileId, options?): Promise<void>;

Defined in: resources/files.ts:107

Удаляет загруженный файл.

Parameters

fileId

string

options?

RequestOptions = {}

Returns

Promise<void>

---

upload()

upload(
   input, 
   uploadOptions?, 
requestOptions?): Promise<UploadedFile>;

Defined in: resources/files.ts:66

Загружает файл и возвращает его идентификатор.

Потоковый источник открывается заново при каждой повторной попытке. Буферный источник после успешного чтения переиспользуется.

Parameters

input

FileInput

uploadOptions?

UploadOptions = {}

requestOptions?

RequestOptions = {}

Returns

Promise<UploadedFile>

---

uploadMany()

uploadMany(
   files, 
   uploadOptions?, 
requestOptions?): Promise<string[]>;

Defined in: resources/files.ts:82

Загружает несколько файлов последовательно, сохраняя порядок.

Parameters

files

FileInput[]

uploadOptions?

UploadOptions = {}

requestOptions?

RequestOptions = {}

Returns

Promise<string[]>