class File/Downloader
<p><h4>File/Downloader применяется для скачивания файлов в кодировке Base64 и документов, доступных по URL.</h4></p><p><p>В качестве опций получает:</p><p> - <b><a class="link-tag" data-className="File/Downloader" data-category="option" data-member="entity">entity</a></b> - сущность для скачивания, закодированная в base64 строка, либо URL адрес документа</p><p> - <b><a class="link-tag" data-className="File/Downloader" data-category="option" data-member="fileParams">fileParams</a></b> (опционально) - объект параметров загружаемого файла (только для base64).</p><p> - <b><a class="link-tag" data-className="File/Downloader" data-category="option" data-member="fileDriver">fileDriver</a></b> (опционально) - файловый драйвер, передается, чтобы явно указать тип загружаемого файла.</p><p> <p> Если файловый драйвер не передан, File/Downloader пытается сам определить файл, и выбрать соответствующий способ скачивания.</p></p><p> <p> Имена файловых драйверов доступны в <b><a class="link-tag" data-className="File/Downloader" data-category="typedef" data-member="DRIVERS_NAMES">Downloader.DRIVERS_NAMES</a> </b> </p></p><p> - (опционально) <b><a class="link-tag" data-className="File/Downloader" data-category="option" data-member="saveMethod">saveMethod</a></b> - Метод сохранения файла, указывается, чтобы явно указать способ сохранения файла (см. <a class="link-tag" data-className="File/Downloader" data-category="typedef" data-member="SAVE_METHODS">Downloader.SAVE_METHODS</a> )</p><p> <p></p><p> Возможные варианты:</p><p> - Downloader.SAVE_METHODS.IFRAME - сохранение через невидимый iframe, быстро, но не позволяет задать параметры сохраняемого файла.</p><p> - Downloader.SAVE_METHODS.BLOB - сохранение через конвертацию в Blob, медленее iframe, но позволяет задать параметры сохраняемого файла.</p><p> </p></p><p> <p></p><p> Возвращаемое значение:</p><p> - В случае скачивания Base64 строки возвращает `Promise<void | Error>`</p><p> - В случае скачивания URL адреса возвращает `Promise<Response| void | Error>`</p><p> </p></p><p><b>Пример использования</b></p>
Примеры
<pre>
require(['File/Downloader'], function(Downloader) {
// Скачивание base64 файла
var base64_text = "wqtXZWVrcyBvZiBjb2RpbmcgY2FuIHNhdmUgeW91IGhvdXJzIG9mIHBsYW5uaW5nwrssDQogdW5rbm93biBhcnRpc3Qu";
Downloader(base64_text, {
name: 'phrase.txt', // Имя, под которым файл будет сохранен (опционально)
contentType: 'text/plain' // Тип контента (опционально)
}, Downloader.DRIVERS_NAMES.Base64) // Имя файлового драйвера, указывает тип скачиваемого файла (опционально)
.catch(console.error); // Обработчик ошибки скачивания
// Скачивание документа по URL
Downloader("https://bad_url").then(parseResponse).catch(console.error);
});
</pre>
Опции
- entity
- <p>URL документа, либо файл в кодировке Base64</p>
- fileDriver
- <p>Имя файлового драйвера, явно указывает тип скачиваемого файла</p>
- fileParams
- <p>Параметры скачиваемого файла</p>
- saveMethod
- <p>Метод сохранения файла, указывается,</p><p>чтобы явно указать способ сохранения файла (см. <a class="link-tag" data-className="File/Downloader" data-category="typedef" data-member="SAVE_METHODS">Downloader.SAVE_METHODS</a> )</p>