AxiosHeaders.js 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344
  1. 'use strict';
  2. import utils from '../utils.js';
  3. import parseHeaders from '../helpers/parseHeaders.js';
  4. const $internals = Symbol('internals');
  5. function normalizeHeader(header) {
  6. return header && String(header).trim().toLowerCase();
  7. }
  8. function normalizeValue(value) {
  9. if (value === false || value == null) {
  10. return value;
  11. }
  12. return utils.isArray(value) ? value.map(normalizeValue) : String(value);
  13. }
  14. function parseTokens(str) {
  15. const tokens = Object.create(null);
  16. const tokensRE = /([^\s,;=]+)\s*(?:=\s*([^,;]+))?/g;
  17. let match;
  18. while ((match = tokensRE.exec(str))) {
  19. tokens[match[1]] = match[2];
  20. }
  21. return tokens;
  22. }
  23. const isValidHeaderName = (str) => /^[-_a-zA-Z0-9^`|~,!#$%&'*+.]+$/.test(str.trim());
  24. function matchHeaderValue(context, value, header, filter, isHeaderNameFilter) {
  25. if (utils.isFunction(filter)) {
  26. return filter.call(this, value, header);
  27. }
  28. if (isHeaderNameFilter) {
  29. value = header;
  30. }
  31. if (!utils.isString(value)) return;
  32. if (utils.isString(filter)) {
  33. return value.indexOf(filter) !== -1;
  34. }
  35. if (utils.isRegExp(filter)) {
  36. return filter.test(value);
  37. }
  38. }
  39. function formatHeader(header) {
  40. return header
  41. .trim()
  42. .toLowerCase()
  43. .replace(/([a-z\d])(\w*)/g, (w, char, str) => {
  44. return char.toUpperCase() + str;
  45. });
  46. }
  47. function buildAccessors(obj, header) {
  48. const accessorName = utils.toCamelCase(' ' + header);
  49. ['get', 'set', 'has'].forEach((methodName) => {
  50. Object.defineProperty(obj, methodName + accessorName, {
  51. value: function (arg1, arg2, arg3) {
  52. return this[methodName].call(this, header, arg1, arg2, arg3);
  53. },
  54. configurable: true,
  55. });
  56. });
  57. }
  58. class AxiosHeaders {
  59. constructor(headers) {
  60. headers && this.set(headers);
  61. }
  62. set(header, valueOrRewrite, rewrite) {
  63. const self = this;
  64. function setHeader(_value, _header, _rewrite) {
  65. const lHeader = normalizeHeader(_header);
  66. if (!lHeader) {
  67. throw new Error('header name must be a non-empty string');
  68. }
  69. const key = utils.findKey(self, lHeader);
  70. if (
  71. !key ||
  72. self[key] === undefined ||
  73. _rewrite === true ||
  74. (_rewrite === undefined && self[key] !== false)
  75. ) {
  76. self[key || _header] = normalizeValue(_value);
  77. }
  78. }
  79. const setHeaders = (headers, _rewrite) =>
  80. utils.forEach(headers, (_value, _header) => setHeader(_value, _header, _rewrite));
  81. if (utils.isPlainObject(header) || header instanceof this.constructor) {
  82. setHeaders(header, valueOrRewrite);
  83. } else if (utils.isString(header) && (header = header.trim()) && !isValidHeaderName(header)) {
  84. setHeaders(parseHeaders(header), valueOrRewrite);
  85. } else if (utils.isObject(header) && utils.isIterable(header)) {
  86. let obj = {},
  87. dest,
  88. key;
  89. for (const entry of header) {
  90. if (!utils.isArray(entry)) {
  91. throw TypeError('Object iterator must return a key-value pair');
  92. }
  93. obj[(key = entry[0])] = (dest = obj[key])
  94. ? utils.isArray(dest)
  95. ? [...dest, entry[1]]
  96. : [dest, entry[1]]
  97. : entry[1];
  98. }
  99. setHeaders(obj, valueOrRewrite);
  100. } else {
  101. header != null && setHeader(valueOrRewrite, header, rewrite);
  102. }
  103. return this;
  104. }
  105. get(header, parser) {
  106. header = normalizeHeader(header);
  107. if (header) {
  108. const key = utils.findKey(this, header);
  109. if (key) {
  110. const value = this[key];
  111. if (!parser) {
  112. return value;
  113. }
  114. if (parser === true) {
  115. return parseTokens(value);
  116. }
  117. if (utils.isFunction(parser)) {
  118. return parser.call(this, value, key);
  119. }
  120. if (utils.isRegExp(parser)) {
  121. return parser.exec(value);
  122. }
  123. throw new TypeError('parser must be boolean|regexp|function');
  124. }
  125. }
  126. }
  127. has(header, matcher) {
  128. header = normalizeHeader(header);
  129. if (header) {
  130. const key = utils.findKey(this, header);
  131. return !!(
  132. key &&
  133. this[key] !== undefined &&
  134. (!matcher || matchHeaderValue(this, this[key], key, matcher))
  135. );
  136. }
  137. return false;
  138. }
  139. delete(header, matcher) {
  140. const self = this;
  141. let deleted = false;
  142. function deleteHeader(_header) {
  143. _header = normalizeHeader(_header);
  144. if (_header) {
  145. const key = utils.findKey(self, _header);
  146. if (key && (!matcher || matchHeaderValue(self, self[key], key, matcher))) {
  147. delete self[key];
  148. deleted = true;
  149. }
  150. }
  151. }
  152. if (utils.isArray(header)) {
  153. header.forEach(deleteHeader);
  154. } else {
  155. deleteHeader(header);
  156. }
  157. return deleted;
  158. }
  159. clear(matcher) {
  160. const keys = Object.keys(this);
  161. let i = keys.length;
  162. let deleted = false;
  163. while (i--) {
  164. const key = keys[i];
  165. if (!matcher || matchHeaderValue(this, this[key], key, matcher, true)) {
  166. delete this[key];
  167. deleted = true;
  168. }
  169. }
  170. return deleted;
  171. }
  172. normalize(format) {
  173. const self = this;
  174. const headers = {};
  175. utils.forEach(this, (value, header) => {
  176. const key = utils.findKey(headers, header);
  177. if (key) {
  178. self[key] = normalizeValue(value);
  179. delete self[header];
  180. return;
  181. }
  182. const normalized = format ? formatHeader(header) : String(header).trim();
  183. if (normalized !== header) {
  184. delete self[header];
  185. }
  186. self[normalized] = normalizeValue(value);
  187. headers[normalized] = true;
  188. });
  189. return this;
  190. }
  191. concat(...targets) {
  192. return this.constructor.concat(this, ...targets);
  193. }
  194. toJSON(asStrings) {
  195. const obj = Object.create(null);
  196. utils.forEach(this, (value, header) => {
  197. value != null &&
  198. value !== false &&
  199. (obj[header] = asStrings && utils.isArray(value) ? value.join(', ') : value);
  200. });
  201. return obj;
  202. }
  203. [Symbol.iterator]() {
  204. return Object.entries(this.toJSON())[Symbol.iterator]();
  205. }
  206. toString() {
  207. return Object.entries(this.toJSON())
  208. .map(([header, value]) => header + ': ' + value)
  209. .join('\n');
  210. }
  211. getSetCookie() {
  212. return this.get('set-cookie') || [];
  213. }
  214. get [Symbol.toStringTag]() {
  215. return 'AxiosHeaders';
  216. }
  217. static from(thing) {
  218. return thing instanceof this ? thing : new this(thing);
  219. }
  220. static concat(first, ...targets) {
  221. const computed = new this(first);
  222. targets.forEach((target) => computed.set(target));
  223. return computed;
  224. }
  225. static accessor(header) {
  226. const internals =
  227. (this[$internals] =
  228. this[$internals] =
  229. {
  230. accessors: {},
  231. });
  232. const accessors = internals.accessors;
  233. const prototype = this.prototype;
  234. function defineAccessor(_header) {
  235. const lHeader = normalizeHeader(_header);
  236. if (!accessors[lHeader]) {
  237. buildAccessors(prototype, _header);
  238. accessors[lHeader] = true;
  239. }
  240. }
  241. utils.isArray(header) ? header.forEach(defineAccessor) : defineAccessor(header);
  242. return this;
  243. }
  244. }
  245. AxiosHeaders.accessor([
  246. 'Content-Type',
  247. 'Content-Length',
  248. 'Accept',
  249. 'Accept-Encoding',
  250. 'User-Agent',
  251. 'Authorization',
  252. ]);
  253. // reserved names hotfix
  254. utils.reduceDescriptors(AxiosHeaders.prototype, ({ value }, key) => {
  255. let mapped = key[0].toUpperCase() + key.slice(1); // map `set` => `Set`
  256. return {
  257. get: () => value,
  258. set(headerValue) {
  259. this[mapped] = headerValue;
  260. },
  261. };
  262. });
  263. utils.freezeMethods(AxiosHeaders);
  264. export default AxiosHeaders;