Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add string[] to AxiosRequestHeaders type #4322

Merged
merged 2 commits into from May 16, 2022

Conversation

estarossa0
Copy link
Contributor

@estarossa0 estarossa0 commented Dec 10, 2021

Regarding #4272, as it say that there is a mismatch between node headers type (node type) and axios request header type within the index signature.
Example of error from next js getServerSideProps request headers:

Argument of type 'IncomingHttpHeaders' is not assignable to parameter of type 'AxiosRequestHeaders'.
  'string' index signatures are incompatible.
    Type 'string | string[]' is not assignable to type 'string'.
      Type 'string[]' is not assignable to type 'string'.

and as mentioned in #4144 anything that toString can apply on will be no harm if added as type.

@bfaulk96
Copy link
Contributor

bfaulk96 commented Dec 10, 2021

Makes sense to me – ["some", "strings", "in", "array"] simply becomes some,strings,in,array when stringified, which is the format of HTTP header lists.

@estarossa0
Copy link
Contributor Author

estarossa0 commented Dec 14, 2021

@bfaulk96 do you have any idea why axios maintainers are not active ? did axios stopped accepting prs ? are they few and thats why it take time to review ? I'm just curious 😅

@bfaulk96
Copy link
Contributor

bfaulk96 commented Dec 20, 2021

@bfaulk96 do you have any idea why axios maintainers are not active ? did axios stopped accepting prs ? are they few and thats why it take time to review ? I'm just curious 😅

Well I'm not a maintainer so I can't really answer that fully haha, but I do know they merged my PR a month or two ago (but didn't create a new release for it yet still).

@jasonsaayman jasonsaayman added component:typescript follow-up Issue or pull request requires a follow. labels May 9, 2022
@jasonsaayman jasonsaayman merged commit ee51e68 into axios:master May 16, 2022
3 checks passed
@estarossa0 estarossa0 deleted the feat/ts-headers branch May 17, 2022
jasonsaayman added a commit that referenced this pull request May 28, 2022
* Fixing proxy beforeRedirect regression (#4708)

* Adding Canceler parameters config and request (#4711)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixed `toFormData` regression bug (unreleased) with Array-like objects serialization; (#4714)

Added `toURLEncodedForm` helper;
Added automatic payload serialization to `application/x-www-form-urlencoded` to have parity with `multipart/form-data`;
Added test of handling `application/x-www-form-urlencoded` body by express.js;
Updated README.md;
Added missed param in JSDoc;
Fixed hrefs in README.md;

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Allow webpack users to overwrite buildins (#4715)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixed `AxiosError` status code type; (#4717)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixed `AxiosError` stack capturing; (#4718)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* allow type definition for axios instance methods (#4224)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* add `string[]` to `AxiosRequestHeaders` type (#4322)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixing AxiosRequestHeaders typings (#4334)

Co-authored-by: Shakirov Kirill <ksshakirov@sberautotech.ru>
Co-authored-by: Jay <jasonsaayman@gmail.com>

* Added the ability for the `url-encoded-form` serializer to respect the `formSerializer` config; (#4721)

Added test for `formSerializer` config in context of `url-encoded-form` serializer;

* Updated eslint config; (#4722)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* fix: add isCancel type assert (#4293)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Added data URL support for node.js; (#4725)

* Added data URL support for node.js;
Added missed data URL protocol for the browser environment;
Optimized JSON parsing in the default response transformer;
Refactored project structure;
Added `cause` prop for AxiosError instance that refers to the original error if it was wrapped with `AxiosError.from` method;
Added fromDataURI helper;
Added test for handling data:url as an `arraybuffer|text|stream`;

* Added throwing of 405 HTTP error if the method is not GET;

* Fix/4263/maxbodylength defaults (#4731)

* test(http): add test case for default body length in follow-redirects

* fix(http): provide proper default body length to follow-redirects

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Adding types for progress event callbacks (#4675)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixed bug #4727 : toFormData Blob issue on node>v17; (#4728)

* Fixed bug #4727;
Added node 18.x to the CI;
Added hotfix for `ERR_OSSL_EVP_UNSUPPORTED` issue with karma running on node >=17.x;
Added `cross-env` to allow running build and test scripts on Windows platforms;

* Added conditional setting of `--openssl-legacy-provider` option for node versions >=17.x;

* Refactored ssl-hotfix & test script;

* Fixed and refactored default max body length test due to ECONNRESET failure;

* Added test for converting the data uri to a Blob;
Fixed bug with parsing mime type for Blob;

Co-authored-by: Jay <jasonsaayman@gmail.com>

* URL params serializer; (#4734)

* Refactored BuildURL helper to use URLSearchParams serializer;

* Updated typings;
Added TS test;

* Added `axios.formToJSON` method; (#4735)

* Draft

* Added `formDataToJSON` helper;
Added `axios.formToJSON` method;
Added client tests;

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Bump grunt from 1.5.2 to 1.5.3 (#4743)

Bumps [grunt](https://github.com/gruntjs/grunt) from 1.5.2 to 1.5.3.
- [Release notes](https://github.com/gruntjs/grunt/releases)
- [Changelog](https://github.com/gruntjs/grunt/blob/main/CHANGELOG)
- [Commits](gruntjs/grunt@v1.5.2...v1.5.3)

---
updated-dependencies:
- dependency-name: grunt
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Updated README.md; (#4742)

Updated index.d.ts;

Co-authored-by: Jay <jasonsaayman@gmail.com>

* chore: removed Travis CI config file as we have moved to GitHub actions

* chore: updated actions to run on new version based branches

* Fix/4737/timeout error message for http (#4738)

* Fixing timeoutErrorMessage in http calls

When timeoutErrorMessage was set this did not change anything in the error message, with this change the error message will be the configured message

* Testing timeoutErrorMessage in http calls

When timeoutErrorMessage was set this did not change anything in the error message, with this change the error message will be the configured message

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixing content-type header repeated (#4745)

Co-authored-by: Jay <jasonsaayman@gmail.com>

Co-authored-by: Maxime Bargiel <maxime.bargiel@gmail.com>
Co-authored-by: 毛呆 <aweikalee@163.com>
Co-authored-by: Dmitriy Mozgovoy <robotshara@gmail.com>
Co-authored-by: Tom Ceuppens <t-c@live.be>
Co-authored-by: Jelle Schutter <jelle@schutter.xyz>
Co-authored-by: Rraji Abdelbari <57002508+estarossa0@users.noreply.github.com>
Co-authored-by: Kirill Shakirov <kirill-shakirov@mail.ru>
Co-authored-by: Shakirov Kirill <ksshakirov@sberautotech.ru>
Co-authored-by: chenjigeng <178854407@qq.com>
Co-authored-by: Dimitris Halatsis <dimitris_ha@hotmail.com>
Co-authored-by: Johann Cooper <johanngcooper@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Victor Augusto <vdbernardes@gmail.com>
Co-authored-by: João Gabriel Quaresma <j.quaresmasantos_98@hotmail.com>
jasonsaayman added a commit that referenced this pull request May 28, 2022
* Fixing proxy beforeRedirect regression (#4708)

* Adding Canceler parameters config and request (#4711)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixed `toFormData` regression bug (unreleased) with Array-like objects serialization; (#4714)

Added `toURLEncodedForm` helper;
Added automatic payload serialization to `application/x-www-form-urlencoded` to have parity with `multipart/form-data`;
Added test of handling `application/x-www-form-urlencoded` body by express.js;
Updated README.md;
Added missed param in JSDoc;
Fixed hrefs in README.md;

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Allow webpack users to overwrite buildins (#4715)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixed `AxiosError` status code type; (#4717)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixed `AxiosError` stack capturing; (#4718)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* allow type definition for axios instance methods (#4224)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* add `string[]` to `AxiosRequestHeaders` type (#4322)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixing AxiosRequestHeaders typings (#4334)

Co-authored-by: Shakirov Kirill <ksshakirov@sberautotech.ru>
Co-authored-by: Jay <jasonsaayman@gmail.com>

* Added the ability for the `url-encoded-form` serializer to respect the `formSerializer` config; (#4721)

Added test for `formSerializer` config in context of `url-encoded-form` serializer;

* Updated eslint config; (#4722)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* fix: add isCancel type assert (#4293)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Added data URL support for node.js; (#4725)

* Added data URL support for node.js;
Added missed data URL protocol for the browser environment;
Optimized JSON parsing in the default response transformer;
Refactored project structure;
Added `cause` prop for AxiosError instance that refers to the original error if it was wrapped with `AxiosError.from` method;
Added fromDataURI helper;
Added test for handling data:url as an `arraybuffer|text|stream`;

* Added throwing of 405 HTTP error if the method is not GET;

* Fix/4263/maxbodylength defaults (#4731)

* test(http): add test case for default body length in follow-redirects

* fix(http): provide proper default body length to follow-redirects

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Adding types for progress event callbacks (#4675)

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixed bug #4727 : toFormData Blob issue on node>v17; (#4728)

* Fixed bug #4727;
Added node 18.x to the CI;
Added hotfix for `ERR_OSSL_EVP_UNSUPPORTED` issue with karma running on node >=17.x;
Added `cross-env` to allow running build and test scripts on Windows platforms;

* Added conditional setting of `--openssl-legacy-provider` option for node versions >=17.x;

* Refactored ssl-hotfix & test script;

* Fixed and refactored default max body length test due to ECONNRESET failure;

* Added test for converting the data uri to a Blob;
Fixed bug with parsing mime type for Blob;

Co-authored-by: Jay <jasonsaayman@gmail.com>

* URL params serializer; (#4734)

* Refactored BuildURL helper to use URLSearchParams serializer;

* Updated typings;
Added TS test;

* Added `axios.formToJSON` method; (#4735)

* Draft

* Added `formDataToJSON` helper;
Added `axios.formToJSON` method;
Added client tests;

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Bump grunt from 1.5.2 to 1.5.3 (#4743)

Bumps [grunt](https://github.com/gruntjs/grunt) from 1.5.2 to 1.5.3.
- [Release notes](https://github.com/gruntjs/grunt/releases)
- [Changelog](https://github.com/gruntjs/grunt/blob/main/CHANGELOG)
- [Commits](gruntjs/grunt@v1.5.2...v1.5.3)

---
updated-dependencies:
- dependency-name: grunt
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Updated README.md; (#4742)

Updated index.d.ts;

Co-authored-by: Jay <jasonsaayman@gmail.com>

* chore: removed Travis CI config file as we have moved to GitHub actions

* chore: updated actions to run on new version based branches

* Fix/4737/timeout error message for http (#4738)

* Fixing timeoutErrorMessage in http calls

When timeoutErrorMessage was set this did not change anything in the error message, with this change the error message will be the configured message

* Testing timeoutErrorMessage in http calls

When timeoutErrorMessage was set this did not change anything in the error message, with this change the error message will be the configured message

Co-authored-by: Jay <jasonsaayman@gmail.com>

* Fixing content-type header repeated (#4745)

Co-authored-by: Jay <jasonsaayman@gmail.com>

Co-authored-by: Maxime Bargiel <maxime.bargiel@gmail.com>
Co-authored-by: 毛呆 <aweikalee@163.com>
Co-authored-by: Dmitriy Mozgovoy <robotshara@gmail.com>
Co-authored-by: Tom Ceuppens <t-c@live.be>
Co-authored-by: Jelle Schutter <jelle@schutter.xyz>
Co-authored-by: Rraji Abdelbari <57002508+estarossa0@users.noreply.github.com>
Co-authored-by: Kirill Shakirov <kirill-shakirov@mail.ru>
Co-authored-by: Shakirov Kirill <ksshakirov@sberautotech.ru>
Co-authored-by: chenjigeng <178854407@qq.com>
Co-authored-by: Dimitris Halatsis <dimitris_ha@hotmail.com>
Co-authored-by: Johann Cooper <johanngcooper@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Victor Augusto <vdbernardes@gmail.com>
Co-authored-by: João Gabriel Quaresma <j.quaresmasantos_98@hotmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
follow-up Issue or pull request requires a follow.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants