Skip to content
GitLab

[TypeScript] typescript-axios: Added possibility to add custom axios instance.

Merged Administrator requested to merge github/fork/sruehl/feature/typescript_custom_axios_instance into master

Created by: sruehl

This comes in handy if you want to use mocks in tests.

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

This PR adds the possibility to supply a custom axios instance to the typescript-axios clients. This then can be used to supply a axios mock adapter in unit-tests: const mock = new MockAdapter(axiosInstance, { delayResponse: 600 }). To test this feature a simple test-case has been added which just supplies the global axios instance.

Updated remark (2018/10/22): One thing we could do different is to supply the instance via configuration or constructor parameter so one doesn't need to supply the instance on every call.

cc: @TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @nicokoenig (2018/09)