@dtinsight/dt-utils
Version:
161 lines (160 loc) • 7.43 kB
JavaScript
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __rest = (this && this.__rest) || function (s, e) {
var t = {};
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
t[p] = s[p];
if (s != null && typeof Object.getOwnPropertySymbols === "function")
for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
t[p[i]] = s[p[i]];
}
return t;
};
/**
* 从指定 URL 下载文件
*
* @category Utils
* @description
* 通过向指定 URL 发送 HTTP 请求（默认为 POST 方法）来下载文件。
*
* 主要功能：
* - 支持自定义请求数据和下载文件名
* - 自动从响应头获取文件名（如果未指定）
* - 处理下载失败的错误情况
*
* 注意事项：
* - 服务端必须返回文件流，若返回 JSON 格式将抛出错误
* - 下载失败时会返回原始响应对象以便进一步处理
* - 仅支持浏览器环境，依赖 document API
*
* @param {string} url - 下载文件的目标 URL
* @param {RequestData} data - POST 请求携带的数据对象（可选）
* @param {DownloadOptions} options - 下载配置项，可包含自定义文件名和其他 fetch 选项
* @returns {Promise<Response>} 返回原始响应对象的 Promise
*
* @example
* ```typescript
* import { downloadFile } from 'dt-utils';
*
* // 基本用法
* await downloadFile('https://api.example.com/download', { id: 123 });
*
* // 使用自定义文件名
* await downloadFile('https://api.example.com/download',
* { id: 123 },
* { fileName: 'custom.pdf' }
* );
*
* // 使用额外的 fetch 选项
* await downloadFile('https://api.example.com/download',
* { id: 123 },
* {
* fileName: 'report.xlsx',
* headers: {
* 'Authorization': 'Bearer token123'
* }
* }
* );
* ```
*/
var downloadFile = function (url, data, options) {
if (data === void 0) { data = {}; }
if (options === void 0) { options = {}; }
return __awaiter(void 0, void 0, void 0, function () {
var fileName, restOptions, response, cloneResponse, contentType, finalFileName, disposition, fileNameMatch, blob, href, link, error_1;
var _a;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
fileName = options.fileName, restOptions = __rest(options, ["fileName"]);
return [4 /*yield*/, fetch(url, __assign({ method: 'POST', body: JSON.stringify(data) }, restOptions))];
case 1:
response = _b.sent();
cloneResponse = response.clone();
if (!response.ok) {
throw cloneResponse;
}
contentType = response.headers.get('Content-Type') || '';
if (contentType.includes('application/json')) {
throw cloneResponse;
}
finalFileName = fileName;
if (!fileName) {
disposition = response.headers.get('Content-Disposition') || '';
fileNameMatch = disposition.match(/filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/);
finalFileName = fileNameMatch
? decodeURIComponent(((_a = fileNameMatch[1]) === null || _a === void 0 ? void 0 : _a.replace(/['"]/g, '')) || '')
: 'download_file';
}
_b.label = 2;
case 2:
_b.trys.push([2, 4, , 5]);
return [4 /*yield*/, response.blob()];
case 3:
blob = _b.sent();
href = URL.createObjectURL(blob);
link = document.createElement('a');
link.href = href;
link.download = finalFileName;
link.style.display = 'none';
document.body.appendChild(link);
link.click();
document.body.removeChild(link);
URL.revokeObjectURL(href);
return [2 /*return*/, cloneResponse];
case 4:
error_1 = _b.sent();
console.warn('Failed to download file:', error_1);
throw cloneResponse;
case 5: return [2 /*return*/];
}
});
});
};
export default downloadFile;